Contributing to PySNN follows the standard protocol:
- Clone the PySNN repository
- Make changes on a separate development branch
- Push the branch to the remote repository
- Open a new pull request
- The pull request is reviewed by one of the maintainers
Clone the PySNN library to your local machine using the following command:
git clone https://github.com/BasBuller/PySNN.git
Your changes should contain logically grouped commits, with each commit containing work on a single subject. Add clear and concise comments that describe the code. In case a new function or class is added also add a docstring that is formatted in ReStructuredText (rst).
Before pushing your changes to the remote, make sure your commits are as clean as possible. Also, be sure to update your working branch to match the latest master branch. This can by done by rebasing your changes on the master branch by using the following command (while working on your development branch):
git pull --rebase origin master
Next, push to the remote repository with the following command:
git push origin [branch name]
Lastly, open a new pull request on the github webpage. Please add a short description of the intention behind the request. If you want a specific reviewer to look at your code, please request so at in the panel on the right when making the pull request.
Once the reviewer is done, your pull request will be merged if everything is looking good. Otherwise, the reviewer will request the kind of changes he/she would like to see. Once the updates are in place, the pull request can be updated.