Community Guidelines

Currently the best way of contributing is by using the tool as it is and opening issues for bugs and questions you have about it. If you have ideas on how to expand or improve the tool in a significant way please contact the developer team to review your proposal.

Contribute

Before emitting any pull request please:

• Open an issue in the issue Tracker using the “Request” Tag.

• Express the reason you think your contribution is important (Fixes a bug, adds related feature etc.)

• Make sure all the unit tests properly run.

• Make sure all your functions and classes have their docstrings in an understandable way and in English. We use the numpy style docstrings

Once made, please tag one of the maintainers so he can review your contribution and merge it.

Report Bugs and Issues

The official channel to report bugs, request features and resolve questions is by opening an issue in the issue board. E-mails are discouraged in this regard. This said, it is important that in your bug report contains:

• The steps to reproduce the problem.

• System specifications and operating system

• Python Version used

• The issue should be opened using the “Bug” label.