Thanks for considering making a contribution to the Sui network or its documentation. Before you get started, please take a moment to read these guidelines.
We appreciate contributions, but simple typo fixes (e.g., minor spelling errors, punctuation changes, or trivial rewording) will be ignored unless they significantly improve clarity or fix a critical issue. If you are unsure whether your change is substantial enough, consider opening an issue first to discuss it.
Found a small error or typo in the main documentation? Each page on the docs.sui.io site includes an Edit this page link at the bottom that you can use to edit the page in GitHub. The content is located in the docs/content directory of the Sui repo, so you can make a PR if you prefer.
For larger documentation issues, you can create an issue in GitHub. To fix the problem yourself, follow the documentation contribution guidelines.
If you change functionality, update the relevant documentation.
Include examples where applicable.
Found a bug or security vulnerability? Please check the existing issues before opening a new one.
Provide as much detail as possible, including steps to reproduce the issue, expected behavior, and actual behavior.
If you want to contribute code that creates a feature on Sui, start with a Sui Improvement Proposal before developing the logic.
Want to contribute to the Sui framework? See CONTRIBUTING.md for information related to sui-framework crate contributions.
Fork the repository and create a new branch for your changes. Ensure your branch is based on the latest main
Follow the coding style and conventions used in the project.
If your change is significant, please open an issue first to discuss it.
Ensure your changes are well-tested. Provide a clear description of your changes in the pull request.
Reference any relevant issue numbers in your pull request. Be responsive to feedback from maintainers.
Follow existing code structure and formatting.
Write meaningful commit messages.
Ensure all tests pass before submitting a pull request.
By contributing, you agree that your contributions will be licensed under the same license as this project.
Thank you for contributing!