Contributing

pyjams development is driven by user feedback, and your contributions help to find bugs, add features, and improve performance. This is a small guide to help those who wish to contribute.

We are happy about all contributions! :thumbsup:

Did you find a bug?

• Ensure that the bug was not already reported under GitHub issues.

• If the bug was not already reported, open a new issue with a clear description of the problem and if possible with a minimal working example.

• Please add the version number to the issue:

  import pyjams
  print(pyjams.__version__)
  

Do you have suggestions for new features?

• Open a new issue with your idea or suggestion and we’d love to discuss about it.

Do you want to enhance pyjams or fix something?

1. Fork the repo on GitHub.

2. Fix a routine or add a new module in src/pyjams.

3. Import a new routine in src/pyjams/__init__.py and add it to __all__.

4. Add some tests either in an existing tests/test_*.py file or create a new test class in a new file under tests/.

5. Add a new module to the automatic documentation by creating a reStructuredText file in docs/source/ as in the example given by docs/source/tee.rst.

6. Add the name of the reStructuredText file to docs/source/api.rst.

7. Add the functions with short descriptions to the alphabetical list and the list per category in README.rst.

8. Do the same in docs/source/index.rst but using markup such as :mod: and :func:.

9. Add yourself to AUTHORS.rst, if you want to.

10. Push to your fork and submit a pull request.