Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 1.9 KB

index.md

File metadata and controls

49 lines (35 loc) · 1.9 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

See Install Sui for installation instructions and our end-to-end tutorial to work with Sui immediately.

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.

File issues

Report bugs and make feature requests in the Sui GitHub repository using the Template for Reporting Issues.

Provide docs feedback

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.

Further reading