Contribution Guidelines#

Submit a new Feature#

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag enhancement.

Next, you can follow this checklist:

  1. Fork the Project

  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)

  3. Commit your Changes (git commit -m 'Add some AmazingFeature')

  4. Push to the Branch (git push origin feature/AmazingFeature)

  5. Open a Pull Request

Tip

If you still need some time developing your feature, you can mark your pull request as a draft.

Submit an Issue#

Feel free to open up any issues you’ve encoutered. Please describe what happend and provide the detailed exception traceback.

Running Tests#

Tests were developed using pytest and can be executed using either tox or pytest:

$ tox # or just 'pytest'

Having a general question?#

Just ask! You can either use Discussions or Github Issues.