Thank you for considering to contribute to this project. These guidelines will help you get going with development and outline the most important rules to follow when submitting pull requests for this project.
- Clone the (forked) repository
- Install dependencies with
poetry install
poetry run pytestTo get changes merged, create a pull request. Here are a few things to pay attention to when doing so:
The summary of a commit should be concise and worded in an imperative mood.
...a what mood? This should clear things up: How to Write a Git Commit Message
This project uses Black for code formatting.
If it makes sense, writing tests for your PRs is always appreciated and will help get them merged.