🙏 Thank you so much for your help in improving the project and pushing Suitears 💧r's long-term success! Many folks will be grateful to you. We are so glad to have you!
There are many ways to get involved at every level. It does not matter if you have just started with Sui Move or are the most experienced expert, we can use your help.
No contribution is too small and all contributions are highly appreciated.
We particularly welcome support in the following areas:
- Reporting issues.
- Fixing and responding to existing issues.
- Implementing changes and/or new features.
- Improving documentation and fixing typos.
If you are writing a new feature and/or a breaking change, please ensure that you include appropriate test cases.
Please follow the recommended design rules.
If you encounter a bug or want to suggest a feature, you are welcome to open an issue. For serious bugs, please do NOT open an issue, but contact us via telegram.
Before opening an issue, please review the existing open and closed issues as well as the existing discussions and consider commenting on one of them instead.
For general types of discussion, e.g. on best practices, formatting, etc., please consider opening a new discussion.
When you propose a new feature, you should provide as much detail as possible, especially on the use cases that motivate it. Features are prioritised by their potential impact on the ecosystem, so we value information that shows the impact could be high.
As a contributor, you are expected to fork the main branch of this repository, work on your own fork, and then submit pull requests. The pull requests are reviewed and eventually merged into the main repository. See "Fork-a-Repo" for how this works.
Format: <emoji><space><Title>
| Type | Emoji |
|---|---|
| readme/docs | 📝 |
| new feature | ✨ |
| refactor/cleanup | ♻️ |
| optimization | ⚡️ |
| configuration | 👷♂️ |
| security fix | 🔒 |
| events | 🔊 |
| bug fix | 🐞 |
Please make sure you follow the conventional function names used on Sui Framework. For example, a function that destroys an empty object should be called destroy_empty.
Please install the Sui binaries and its dependencies.
Please run the command below on your terminal to verify that you have Sui installed.
sui