Anybody is welcome to create a branch on this repository and make edits. If you'd like to have your code merged back into the master branch, please ensure you do the following before opening the pull request:
Use a real source code editor that ensures no tab characters in .py or .pyx files and 4 white spaces for indentation. Don't reformat or reorganize code unless you are actually making non-trivial modifications and make sure your editor is not automatically reformatting. Try to follow pep8 for Python code.
Before we merge any code into master we verify that all tests run. You can run these yourself with:
- make test
If you are adding any new features, please write test cases that cover your features.
When you submit a pull request to this repository for the first time, you need to sign a Developer Certificate of Origin ("DCO"). To read and agree to the DCO, you'll add your name and email address to Contributors.md. At a high level, it tells us that you have the right to submit the work you're contributing in your pull requests and says that you consent to us treating the contribution in a way consistent with the license associated with this software and its documentation ("Project"). You can read the license associated with this project in LICENSE.md.
You can submit contributions anonymously or under a pseudonym if you'd like, but we need to be able to reach you at the email address you list when you agree to the DCO.
It probably goes without saying, but contributions you make to this public Department of Defense repository are completely voluntary. When you submit a pull request, you're offering your contribution without expectation of payment and you expressly waive any future pay claims against the U.S. Federal government related to your contribution.
Once your branch is ready to be merged please open a pull request and assign it to one of the repository admins. (Currently @cekees).