In order to contibute to this repository you will need developer access to this repo. To know more about the project go to the README first.
Pre-commits hooks have been configured for this project using the pre-commit library:
To get them going on your side, first install pre-commit:
pip install pre-commitThen run the following commands from the root directory of this repository:
pre-commit install
pre-commit run --all-filesThese pre-commits are applied to all the files, except the directory tmp/ (see .pre-commit-config.yaml)
Commits should start with a Capital letter and should be written in present tense (e.g. 🎉 Add cool new feature instead of 🎉 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. |
🔧 :wrench: |
When you refactored / improved a small piece of code. |
🔨 :hammer: |
When you refactored / improved large parts of the code. |
✨ :sparkles: |
When you applied clang-format. |
🎨 :art: |
When you improved / added assets like themes. |
🚀 :rocket: |
When you improved performance. |
📝 :memo: |
When you wrote documentation. |
🪲 :beetle: |
When you fixed a bug. |
🔀 :twisted_rightwards_arrows: |
When you merged a branch. |
🔥 :fire: |
When you removed something. |
🚚 :truck: |
When you moved / renamed something. |
✅ :white_check_mark: |
When you add a new unit test |