Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

62 lines (39 loc) · 2.1 KB

CONTRIBUTING: Notes on forks and pull requests

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

  • Code revisions: please kindly follow Github flow.

  • Running tests: details are in the tests directory. Python tests will run under both py.test and nosetests.

  • For integration testing, we run all notebooks in batch mode in a Linux environment. This also syncs temporary notebooks with current data.

  • If you have modified code in a Jupyter/IPython notebook where there are many embedded images, please clear out all outputs before your commit. (The only exception arises in the case of major releases where we want archival samples of images generated).

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. Be sure to pull origin/master and rebase before the next step.
  5. Push to your fork and submit a pull request
  6. Kindly wait for your pull request to be reviewed.
  7. Stay in touch with fellow developers at Gitter.

Tips regarding pull requests

  • Refine 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 : 2016-01-23