Contribute to Sui Repositories
Sui repositories are open source and welcome community contributions.
This page describes how to contribute to Sui, and provides additional information about participating in the Sui community.
Join the community
To connect with the Sui community, join our Discord.
Open issues
To report an issue with Sui, create an issue in the GitHub repo. Click Get started to open a template for the type of issue to create.
Fork Sui to contribute
To contribute to Sui source code or documentation, you need only a GitHub account. Follow these steps to submit a contribution:
- Fork the MystenLabs/sui repository by clicking Fork on the GitHub page.
- Clone your fork locally:
$ git clone https://github.com/YOUR_USERNAME/sui.git - Create a feature branch from
main:$ git checkout -b your-branch-name main - Make your changes and commit them with a descriptive message.
- Push your branch to your fork:
$ git push origin your-branch-name - Open a pull request from your branch to the
mainbranch of MystenLabs/sui.
Always submit PRs to the main branch. See Sui Environment Setup for additional instructions on configuring your local environment.
Contribute through the Sui Improvement Proposal (SIP) process
The Sui Network is an open source, decentralized, and permissionless protocol that welcomes community contributions. If you have an idea regarding a core protocol upgrade, submit a Sui Improvement Proposal (SIP). For more information on the SIP process, see Contribute to Sui through SIPs.