We are happy to receive contributions in the form of pull requests via Github. Feel free to fork the repository, implement your changes and create a merge request to the main branch.
Commits should start with a Capital letter and should be written in present tense (e.g. :tada: Add cool new feature instead of :tada: Added cool new feature).
You should also start your commit message with one applicable emoji. This does not only look great but also makes you rethink what to add to a commit. Make many but small commits!
| Emoji | Description |
|---|---|
🎉 :tada: |
When you added a cool new feature |
🐛 :bug: |
When you refactored / When you fixed a bug |
🔥 :fire: |
When you removed something. |
🚚 :truck: |
When you moved / renamed something. |
🔧 :wrench: |
When you refactored / improved a small piece of code. |
🔨 :hammer: |
When you refactored / improved large parts of the code. |
✨ :sparkles: |
When you improved code quality (pylint, PEP, ...). |
🎨 :art: |
When you improved / added design assets. |
🚀 :rocket: |
When you improved performance. |
📝 :memo: |
When you wrote documentation. |
☔ :umbrella: |
When you improve coverage. |
🔀 :twisted_rightwards_arrows: |
When you merged a branch. |
This section was inspired by This repository.
Version numbers will be assigned according to the Semantic Versioning. scheme. This means, given a version number MAJOR.MINOR.PATCH, we will increment the:
- MAJOR version when we make incompatible API changes,
- MINOR version when we add functionality in a backwards compatible manner, and
- PATCH version when we make backwards compatible bug fixes.