Contributing to PyStokes

Any new addition is to go through a pull request. First, fork the PyStokes repository and then add changes on your fork of the repository. Open a pull request with your changes once it passes all tests (see here) and CI.

Any new features added should follow the following rules:

• PEP8 style guide should be followed
• All functions and classes must contain numpy dosctrings
• All new features should include corresponding unit tests

This is for all new contributors who have push access to the repository. Please create a new branch. The idea is that everyone uses branches created from master to experiment, make edits, additions and other changes. Once this branch passes all CI tests, then it can be merged to master after the changes have been approved.