Contributions in the form of bug reports, bug fixes, improvements to the documentation, ideas for enhancements (or the enhancements themselves!) are very welcome.
You can find a list of current issues in the project's GitHub repo. Feel free to tackle any existing bugs or enhancement ideas by submitting a pull request.
- Please include a short (but detailed) Python snippet or explanation for reproducing the problem. Attach or include a link to any input files (e.g. wrapped module and yaml configuration) that will be needed to reproduce the error.
- Explain the behavior you expected, and how what you got differed.
- Please reference relevant GitHub issues in your commit message using
GH123or#123. - Changes should be PEP8 compatible.
- Keep style fixes to a separate commit to make your pull request more readable.
- When you start working on a pull request, start by creating a new branch pointing at the latest commit on GitHub master.
- The ctwrap copyright policy is detailed in the
LICENSE.
The documentation is currently limited to docstrings that may be incomplete (as well as jupyter usage examples). Additional comments (or fully standardized docstrings - e.g. NumPy style) will be added based on need and/or interest.
Rudimentary tests are implemented.
Thanks to the useful contributing guide of SLACKHA, which served as an inspiration and starting point for this guide.