- Submit an issue to notify us with your plan in advance.
- Fork this repo to your own GitHub account. The detailed logistics to fork the repo, track the original repository as a remote of the fork, etc., can be found in this comprehensive guide by Jake Jarvis: How To Fork a GitHub Repository & Submit a Pull Request
- Set this repo as the
upstream
remote and pull the latest commits to your own repo. - Create a new branch from
master
and make changes there. - Before submitting a pull request, make sure you:
- no longer have new commits to push,
- run through all unit tests
pytest tests/
and make sure they all pass (if your changes cause some tests to fail, check and fix them), and - have merged all commits from
master
of this repo onto your branch.
- Please include the maintainers of this repo as reviewers of your pull request:
- Clare Huang
@csyhuang
- Christopher Polster
@chpolste
- Clare Huang
This page is subject to changes. Suggestions on improvement are welcome.