Skip to content

Latest commit

 

History

History
17 lines (11 loc) · 1.56 KB

CONTRIBUTING.rst

File metadata and controls

17 lines (11 loc) · 1.56 KB

PBjam is open source and we welcome contributions, large or small!

Raising issues

If you're having problems with the code, either because you uncover a bug or there's something that's just totally unintuitive about using PBjam, feel free to raise an issue (do search the list of issues first though!). When raising issues please explain what you tried to do, how to did it, and what PBjam threw back at you when you did.

We will try to address the issue as soon as possible.

Making pull requests

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! Please clearly explain what the pull request is meant to fix, and how you went about fixing it.

You can also add new features, this might take a bit more back-and-forth with the main authors of PBjam, as we do have some ideas about what PBjam is meant for. Read the visions notes where we try to explain the rational behind PBjam.

Please make sure to include docstrings in your submissions, along with the odd inline comment. This makes reviewing the submission that much easier. See the example docstring for ideas on writing basic documentation.

Providing a few unit tests of your functions would be very helpful.See the example unittest for a very simple example.