Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 2.14 KB
Raw

Contributing to inrc_ecosystem

Everyone is welcome to contribute. Patches may be submitted using GitHub pull requests (PRs). All commits must be signed off by the developer (--signoff) which indicates that you agree to the Developer Certificate of Origin. Patch discussion will happen directly on the GitHub PR. Design pre-work and general discussion occurs on the [mailing list]. Anyone can provide feedback in either location and all discussion is welcome. Decisions on whether to merge patches will be handled by the maintainer.

Process

  1. Submit Github pull request (PR) for any new feature or bug fix
  2. Explain any architectural changes or network topology with diagrams for reviewers
  3. Run pylint scan on the codebase after making changes
  4. Ensure you have a README if you are adding a new tutorial/model/module
  5. If you have dependency on another module, use git submodule to create a link
  6. Mention the version of nxsdk you used to verify on the README
  7. (Preferred) Add unit tests

As soon as you create a PR, we will acknowledge the commit in 2 days.

Reviewers should get back to you within 10 days with either a go-ahead or might request more information or need more time to review the change. We expect reviews to finish within 4 weeks.

Once the PR is ready to be merged, one of the reviewers will merge your changes.

License

inrc_ecosystem repository is licensed using a BSD 3-clause [license]. All code submitted to the project is required to carry that license.

Mailing List

Contributors and users are welcome to submit new request on our roadmap, submit patches, file issues, and ask questions at intel-ncl.atlassian.net.

Legal

This software is subject to the U.S. Export Administration Regulations and other U.S. law, and may not be exported or re-exported to certain countries (Cuba, Iran, Crimea Region of Ukraine, North Korea, Sudan, and Syria) or to persons or entities prohibited from receiving U.S. exports (including Denied Parties, Specially Designated Nationals, and entities on the Bureau of Export Administration Entity List or involved with missile technology or nuclear, chemical or biological weapons).