CONTRIBUTING: Notes on forks and pull requests

June 25, 2018 ยท View on GitHub

We are thrilled that you would like to collaborate on this project. Your help is essential.

  • Code revisions: please kindly follow Github flow with respect to the develop branch.

  • Running tests: details are in the tests directory. Python tests are designed run under py.test with with the --doctest-modules flag.

  • For integration testing, we run Travis.

Submitting a pull request

  1. Fork and clone the repository.
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change, add tests, and make sure the tests still pass.
  4. Tests are strict on PEP8, so please use flake8 as your lint program.
  5. Be sure to pull origin/develop and rebase before the next step.
  6. Push to your fork and submit a pull request
  7. Kindly wait for your pull request to be reviewed.
  8. Stay in touch with fellow developers at Gitter.

Tips regarding pull requests

  • Refine and add tests whenever possible.

  • Update documentation as necessary.

  • Keep your change focused. If there are multiple changes that are not dependent upon each other, please submit them as separate pull requests.

  • Write a good commit message.

Thank you very much for your consideration. Your contributing work is very appreciated.

Resources

Revision date : 2018-06-25