We want to make contributing to this project as easy and transparent as possible.
Our plans and features are developed openly on the Github Issues. Items in line for the next release will be tagged with a version number on github.
We actively welcome your pull requests.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- If you haven't already, complete the Contributor License Agreement ("CLA").
In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Meta's open source projects.
Complete your CLA here: https://code.facebook.com/cla
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
Meta has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
We provide a style file for the python code that can be run by running flake8 . and then pydocstyle . from the root folder. Pull Requests must pass both of these as well as the unit tests in the tests folder to be reviewed.
By contributing to Nocturne, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.