Contribute to N3N

Sep 21, 2021

Dec 20, 2023

2 minutes

contributorfoundation

The N3N division contributor guidelines is an invitation letter to all the people out there who believes in the power of technology through contribution, making lives better for everyone.

Getting Started

1. Join the Community:

   • Start by joining the N3N community. Connect with fellow contributors, share your experiences, and stay informed about ongoing projects.

2. Explore Projects:

   • Dive into our diverse range of projects. Find areas that align with your interests and expertise.

3. Read the Code of Conduct:

   • Familiarize yourself with our Code of Conduct to understand our shared expectations.

How to Contribute

1. Open Issues:

   • If you're ready to contribute, check our open issues tagged as help wanted or good first issue.
   • Comment on the issue to express your interest or ask questions.

2. Making Changes:

   • Before contributing, review our community guidelines to understand our policies.
   • Fork [the repository].
   • Choose the appropriate branch based on the version you want to develop.
   • Start making changes in your own branch, ensuring there are no build errors by running the project locally.

3. Write Tests:

   • Write tests to validate your changes and ensure the existing functionality is not affected.

4. Sign Your Work:

   • Sign your work using the Developer Certificate of Origin. Your signature certifies your submission.

   Signed-off-by: Your Name <your.email@example.com>
   

5. Open a Pull Request:

   • Open a pull request with a descriptive name and detailed description of your changes.
   • Read more about working with pull requests on GitHub here.

6. Review Process:

   • A maintainer will review your pull request and may ask for changes if necessary.

Code Guidelines

Follow language-specific code guidelines:

• Rust:

  • Read the standards and recommendations for working with Rust here.

• Python:

  • Follow PEP8 conventions when working with Python modules.

• JavaScript & TypeScript:

  • Use Prettier with default settings to auto-format JavaScript and TypeScript code.

Licensing

Unless otherwise specified, all N3N open source projects comply with the Rust standard licensing model (MIT + Apache 2.0).

Contributor Terms

By contributing, you agree to the Contributor Terms. Ensure your contributions adhere to our community guidelines.

Thank you for being a valuable part of N3N!