Contributor Guidelines
Sep 21, 2021
Oct 05, 2021
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.
Hello Friend,
You are here to contribute to this project right?
Welcome aboard! This project is created by the team at the NCRYPTO Opensource Privacy and Security Norms division informally known as the N3N. We're glad you're interested in contributing! We welcome contributions from people of all backgrounds who are interested in making great software with us.
At N3N, our motto is Privacy, Independency, Transparency and Security. We envision to empower everyone to maintain their own privacy and security in a trivial way to live a hygienic digital life. To do this, we're exploring and pushing the boundaries of new technologies, and sharing our learnings with the open source community. By being transparent about it, enables us to make you more independent in a way that preserves your rights to privacy while establishing your security on the digital space.
If you have ideas for collaboration, email us at we@n3n.org.
Our heartfelt thanks,
The N3N Authors
Issues
Security Vulnerablity
The X team at N3N and our community take security issues in our associated projects at first priority. We sincerely appreciate your toiling efforts to disclose your findings privately, and as a token of gratitude and your faith in us, we will make every effort to acknowledge your contributions, including and not limited to N3NX hunter hall of fame.
To report a security issue, email security@n3n.org and include the word "SECURITY" in the subject line.
We'll endeavor to respond quickly, and will keep you updated throughout the process.
Also at Knytx Labs, We're hiring full-time, aptly skilled hackers to work with us! Check out our current job postings here.
Feature Requests
If you have ideas or how to improve our projects, you can suggest features by opening a GitHub issue. Make sure to include details about the feature or change, and describe any uses cases it would enable.
Feature requests will be tagged as enhancement and their status will be updated in the comments of the issue.
Bugs
When reporting a bug or unexpected behaviour in a project, make sure your issue describes steps to reproduce the behaviour, including the platform you were using, what steps you took, and any error messages.
Reproducible bugs will be tagged as bug and their status will be updated in the comments of the issue.
Wontfix
Issues will be closed and tagged as wontfix if we decide that we do not wish to implement it, usually due to being misaligned with the project vision or out of scope. We will comment on the issue with more detailed reasoning.
Contribution Workflow
Open Issues
If you're ready to contribute, start by looking at our open issues tagged as help wanted or good first issue.
You can comment on the issue to let others know you're interested in working on it or to ask questions.
Making Changes
Fork the repository.
Create a new feature branch.
Make your changes. Ensure that there are no build errors by running the project with your changes locally.
Open a pull request with a name and description of what you did. You can read more about working with pull requests on GitHub here.
A maintainer will review your pull request and may ask you to make changes.
Code Guidelines
Rust
You can read about our standards and recommendations for working with Rust here.
Python
We recommend following PEP8 conventions when working with Python modules.
JavaScript & TypeScript
We use Prettier with the default settings to auto-format our JavaScript and TypeScript code.
Licensing
Unless otherwise specified, all N3N open source projects shall comply with the Rust standard licensing model (MIT + Apache 2.0) and are thereby licensed under a dual license, allowing licensees to choose either MIT OR Apache-2.0 at their option.
Contributor Terms
Thank you for your interest in this N3N open source project. By providing a contribution (new or modified code, other input, feedback or suggestions etc.) you agree to these Contributor Terms.
You confirm that each of your contributions has been created by you and that you are the copyright owner. You also confirm that you have the right to provide the contribution to us and that you do it under the Rust dual license model (MIT + Apache 2.0).
If you want to contribute something that is not your original creation, you may submit it to N3N separately from any contribution, including details of its source and of any license or other restriction (such as related patents, trademarks, agreements etc.)
Please also note that our projects are released with a Contributor Code of Conduct to ensure that they are welcoming places for everyone to contribute. By participating in any of the N3N open source project, you agree to keep to the Contributor Code of Conduct.