Issues, suggested changes and comments of any kind are welcome. This document serves to make it as painless as possible to contribute by explaining how your contribution are included as fast as possible.
If you would simply like to get in touch with us, please contact us via email:
- C. Pehle
<[email protected]> - J. Pedersen
<[email protected]>
Bug reports are most welcome, but please be as specific and constructive as possible. As a minimum you should include
- What the problem is, stated briefly
- How it happened, and how it can be reproduced
- Why this is a problem
- This might not be clear to someone else than you. The clearer you can make it, the faster it will be understood and fixed
Assuming you have a feature you would like to implement, we recommend the following steps:
- Fork the repository
- Implement your feature
- Make sure the feature is tested using pytest and that your test passes
- Push the code to your fork and submit a pull request, possibly with a link to any issues of relevance
- React to any feedback we give around the fork. We might ask you to fix minor issues before merging it with the main branch.
We will try to get around to your contributions as fast as possible. And thank you for taking the time to improve the code!