Skip to content

Commit

Permalink
updates README and add LICENCE and CONTRIBUTING (#36)
Browse files Browse the repository at this point in the history
updates readme and add license and contributing files

---------

Co-authored-by: Nathan Seva <[email protected]>
  • Loading branch information
gregLibert and Thykof authored Mar 30, 2023
1 parent 626493c commit 2793ed8
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 18 deletions.
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing to Massa Standard Definition

Thank you for your interest in contributing to the Massa Standard Definition project!

This project is open to contributions from anyone in the Massa community, and we welcome your input.

## Getting Started

To get started with contributing to the project, please follow these steps:

1. Fork the repository on GitHub.
2. Clone the forked repository to your local machine.
3. Create a new branch for your changes.
4. Make your changes and commit them to your branch.
5. Push your branch to your forked repository on GitHub.
6. Create a pull request to merge your changes into the main repository.

## Guidelines

When contributing to the project, please follow these guidelines:

- Use clear and concise language in your code and documentation.
- Ensure that your code is well-structured and easy to read.
- Be respectful and professional in your interactions with other contributors.

## Template

Please use the following template when starting a new standard:

```markdown
# Name

**Authors:**

**Status:** Draft, Effective or Deprecated

**Version:** 0.1

## Abstract

## Targeted Audience

## Specification

## Implementation

```

## License

By contributing to massa standard, you agree that your contributions will be licensed under the MIT License.
21 changes: 21 additions & 0 deletions LICENCE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Massa

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
50 changes: 32 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,46 @@
# massa-standards
# Massa Standard Definition

This repository lists all massa standard specifications and reference implementations.
Welcome to the Massa Standard Definition project!

Massa standards
This project aims to establish a common set of standards for the Massa blockchain ecosystem. The standards defined here will help to promote interoperability and ease of use for Massa-based applications and services.

- [smart contracts](smart-contracts/README.md)
If you're interested in learning more about Massa and its capabilities, check out the following resources:

## How to write a standard?
- [Massa website](https://massa.net): This is the official website for the Massa blockchain. Here, you can learn more about Massa's features and use cases, as well as explore the Massa ecosystem and community.
- [Massa documentation](https://docs.massa.net/en/latest/): This is the official documentation for Massa. Here, you can find detailed guides and tutorials for developing on the Massa blockchain, as well as API reference documentation for the Massa SDK and other tools.

Create a `.md` file that follow this structure:
## Fungible Token

```markdown
# Standard name
The [Fungible Token standard implementation](smart-contracts/assembly/contracts/FT) defines a common set of rules for creating and managing Massa-based tokens that are fungible (i.e. interchangeable).

Initial issue: <https://github.com/massalabs/massa-standards/issues/{issue number}>
This is MassaLabs implementation of [the ERC20](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/).

## Abstract
## Non-Fungible Token

## Motivation
The [Non-Fungible Token standard implementation](smart-contracts/assembly/contracts/NFT) defines a common set of rules for creating and managing Massa-based tokens that are non-fungible (i.e. unique).

## Specification
This is MassaLabs implementation of [the ERC721](https://ethereum.org/en/developers/docs/standards/tokens/erc-721/).

## Implementation
## Massa Units

```
The [Massa Units standard](units.md) defines a set of common units of measurement for use on the Massa blockchain.

Fill the issue number. The issue would probably be a meta issue. Sub-issues would be issue to implement
the standard in proper repositories.
These units include:

> _NOTE:_ this [VSCode extension](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
can help you to format markdown files.
- Massa coin
- Gas
- Rolls

## DApps <> Wallet Provider Communication

The [DApps <> Wallet Provider Communication standard](wallet/dapps-communication.md) defines a common interface for communication between Massa-based decentralized applications (DApps) and wallet providers.

This standard aims to simplify the process of integrating Massa-based DApps with various wallet providers, making it easier for end-users to access and use these applications.

## Contributing

To contribute to the Massa Standard Definition project, please refer to the document [contributing](CONTRIBUTING.md).

## License

This project is licensed under the MIT license. For more information, please refer to the [LICENSE file](LICENCE).

0 comments on commit 2793ed8

Please sign in to comment.