navi-sdk
Version:
The NAVI SDK Client provides tools for interacting with the Sui blockchain networks, designed for handling transactions, accounts, and smart contracts efficiently. This documentation covers the setup, account management, and transaction handling within th
42 lines (30 loc) • 2.8 kB
Markdown
# NAVI Open Source Contribution Policy
We welcome and appreciate contributions of quality code from anyone.
## Contribution Guidelines
### Code Standards
To ensure high quality and maintainability of our codebase, please adhere to the following standards:
* ***Follow the existing coding style***: Maintain consistency with the project's current code style.
* ***Documentation***: Ensure your code is well-documented, making it easy for others to understand and use.
* ***Unit Tests***: Write unit tests for any new functionality to ensure reliability and prevent future issues.
* ***Testing***: Run all tests to confirm that nothing is broken by your changes.
### Code Review Process
All Pull Requests (PRs) will undergo a thorough review process:
* ***Review***: NAVI Protocol officials will review all PRs to ensure they meet our standards and project goals.
* ***Feedback***: Reviewers may request changes or seek clarifications on your code.
### Responsiveness
* ***Feedback***: Be responsive to feedback from reviewers and make the necessary changes promptly to facilitate a smooth review process.
### Merging
* ***Approval***: Once your PR is approved, it will be merged into the codebase by one of the maintainers.
## We Eager to accept
We will incorporate your contribution into the project’s codebase, adapt it as needed, and give you full credit for your work.
### Contributions
We accept a wide range of contributions, including code, documentation, and artistic works, as long as they are valuable and useful. The easier it is for us to integrate your contribution, the better. However, if your contribution is of high quality, we will make the necessary effort to use it.
### From anyone
We accept contributions from anyone, regardless of race, religion, national origin, gender, sexual orientation, lifestyle, political viewpoint, or any other extraneous factors. Contributions are judged solely on their quality. However, we reserve the right to reject contributions if the contributor behaves inappropriately.
### That we can use
Your contribution must:
* Be given freely and irrevocably
* Be your own work, and you must have the right to contribute it
* Be made under a license compatible with the project’s license, allowing us to include, distribute, and modify your work without restriction
## If Your Contribution Is Rejected
Rejection of your contribution does not reflect on you personally; it simply means that the contribution was not suitable for our project in its current form. If you ask civilly, we will discuss the reasons for rejection and help you understand how to improve your contribution for future acceptance. If we cannot reach an agreement, you are free to fork our project and add your contribution to your fork, as with any Open Source project.