Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 1.23 KB

index.md

File metadata and controls

31 lines (25 loc) · 1.23 KB
Raw
title
Contributing to Sui

Now that you understand Sui, consider helping the project. To contribute to Sui, ensure you have the latest version of the codebase. To clone the repository, run the following:

git clone https://github.com/mystenlabs/sui.git
cd sui
cargo build --all --all-targets
cargo test

Pull requests

To submit your pull request:

  1. Fork the sui repository and create your branch from main.
  2. If you have added code that should be tested, add unit tests.
  3. If you have made changes to APIs, update the relevant documentation, and build and test the developer site.
  4. Verify and ensure that the test suite passes.
  5. Make sure your code passes both linters.
  6. Complete the Contributor License Agreement (CLA), if you haven't already done so.
  7. Submit your pull request.

Further reading