| title |
|---|
Contributing to Sui |
Report bugs and make feature requests in the Sui GitHub repository using the Template for Reporting Issues.
Send us documentation fixes or requests for improvement at: [email protected]
You may also suggest changes to the docs directly in GitHub right here using the Source Code link below.
Simply edit the file in question and generate a pull request. We will get back to you shortly.
Start by creating your own fork of the repo:
gh fork https://github.com/mystenlabs/sui.git # or alternatively, clone your fork
cargo install --path sui/sui # put Sui CLI's in your PATH
cd sui
cargo build --all --all-targets # check that build works
cargo test # check that tests passTo submit your pull request:
- Make your changes in a descriptively named branch.
- If you have added code that should be tested, add unit tests.
- Ensure your code builds and passes the tests:
cargo test - Make sure your code passes the linters and autoformatter:
cargo clippy --all --all-targets && cargo fmt --all - If you have made changes to APIs, update the relevant documentation, and build and test the developer site.
- Run
git push -f origin <branch_name>, then open a pull request from the Sui GitHub site.
- Learn about Mysten Labs the company on our public site.
- Read the Sui Smart Contract Platform white paper.
- Implementing logging in Sui to observe the behavior of your development.
- Find related research papers.
- See and adhere to our code of conduct.