Skip to content

Commit 88f98b3

Browse files
Update CONTRIBUTING.md (MystenLabs#21027)
## Description This PR updates the contributing guideline to be more comprehensive, and also exposes it to the main README file by linking it. ## Test plan How did you test the new or updated feature? --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] gRPC: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK:
1 parent d6ed8a5 commit 88f98b3

File tree

2 files changed

+65
-7
lines changed

2 files changed

+65
-7
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,62 @@
1-
# Contributors
1+
# Contributing to This Project
22

3-
Thanks for considering making a contribution to the Sui network or its documentation. The Sui monorepo houses the code that powers and documents the Sui blockchain.
3+
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.
44

5-
## Contribute to Sui
5+
## Important Note
66

7-
See [Sui Environment Setup](https://github.com/MystenLabs/sui/blob/main/docs/content/references/contribute/sui-environment.mdx) for approach to submitting code fixes and enhancements.
7+
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.
8+
9+
# How to Contribute
810

9-
If you want to contribute code that creates a feature on Sui, start with a [Sui Improvement Proposal](https://github.com/sui-foundation/sips/tree/main) before developing the logic.
1011

11-
Found a bug or security vulnerability? Create a [GitHub issue](https://github.com/MystenLabs/sui/issues/new/choose).
12+
## Documentation
1213

13-
Found a small error or typo in the documentation? Each page on the [docs.sui.io](https://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 usual PR if you prefer.
14+
Found a small error or typo in the main documentation? Each page on the [docs.sui.io](https://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.
1415

1516
For larger documentation issues, you can [create an issue](https://github.com/MystenLabs/sui/issues/new/choose) in GitHub. To fix the problem yourself, follow the [documentation contribution](./docs/content/references/contribute/contribution-process.mdx) guidelines.
1617

18+
If you change functionality, update the relevant documentation.
19+
20+
Include examples where applicable.
21+
22+
## Reporting Issues
23+
24+
Found a bug or security vulnerability? Please check the existing issues before opening a new one.
25+
26+
Provide as much detail as possible, including steps to reproduce the issue, expected behavior, and actual behavior.
27+
28+
## New Sui features
29+
30+
If you want to contribute code that creates a feature on Sui, start with a [Sui Improvement Proposal](https://github.com/sui-foundation/sips/tree/main) before developing the logic.
31+
32+
## New Sui Framework Contributions
33+
1734
Want to contribute to the Sui framework? See [CONTRIBUTING.md](https://github.com/MystenLabs/sui/blob/main/crates/sui-framework/CONTRIBUTING.md) for information related to `sui-framework` crate contributions.
35+
36+
## Proposing Code Changes
37+
38+
Fork the repository and create a new branch for your changes. Ensure your branch is based on the latest main
39+
40+
Follow the coding style and conventions used in the project.
41+
42+
If your change is significant, please open an issue first to discuss it.
43+
44+
## Submitting a Pull Request
45+
46+
Ensure your changes are well-tested. Provide a clear description of your changes in the pull request.
47+
48+
Reference any relevant issue numbers in your pull request. Be responsive to feedback from maintainers.
49+
50+
## Code Standards
51+
52+
Follow existing code structure and formatting.
53+
54+
Write meaningful commit messages.
55+
56+
Ensure all tests pass before submitting a pull request.
57+
58+
# License
59+
60+
By contributing, you agree that your contributions will be licensed under the same license as this project.
61+
62+
Thank you for contributing!

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,16 @@ Use the following links to learn more about Sui and the Sui ecosystem:
5656
* Join the Sui community on [Sui Discord](https://discord.gg/sui).
5757
* Find out more about the Sui ecosystem on the [Sui Resources](https://sui.io/resources/) page.
5858
* Review information about Sui governance, [decentralization](https://suifoundation.org/decentralization), and [Developer Grants Program](https://sui.io/grants-hub) on the [Sui Foundation](https://suifoundation.org/) site.
59+
60+
61+
## How to Contribute
62+
63+
See the [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to Sui.
64+
65+
## Code of Conduct
66+
67+
See the [Code of Conduct](CODE_OF_CONDUCT.MD) for details on our code of conduct.
68+
69+
## License
70+
71+
See the [LICENSE](LICENSE) file for more details.

0 commit comments

Comments
 (0)