PBjam is open source and we welcome contributions, large or small!
If you are having problems with the code, either because you found a bug or because something is unintuitive, feel free to raise an issue. Please search the existing issues first. When opening an issue, explain what you tried, how you ran it and what PBjam returned.
We will try to address the issue as soon as possible.
If you spot an issue that you know the solution to, and can write a patch for it, feel free to make a pull request for it!
One way to do this is:
- Go to Branches
- Create a new branch from the dev branch
- Clone the repo to your local machine
- On your local machine do
Checkout mynewbranch, do the edits and push the changes to the new branch on Github. - You can then submit a pull request which will be reviewed.
For changes big or small, or new features please only create branches off of the dev branch, not master
Also, please clearly explain what the pull request is meant to fix, and how you went about fixing it.
Please include docstrings in your submissions, along with inline comments where they clarify the implementation. See the example docstring for ideas on writing basic documentation.
Please also provide unit tests for new or changed behaviour. See the example unit test for a simple example.