All commit messages MUST respect the following format :
:emoji1: :emoji2: short description of modifications.
- Short description must begin by a Capitalize character.
- Each commit must write in the present.
- You must add one emoji or more to help people about changes made in project.
- If you post an WiP commit, you MUST indicate it by the emoji 🚧
- Respect Markdown rules.
- Respect emoji description below to indicate the modification made in the commit.
| Emoji | Emoji code | Description |
|---|---|---|
| 📰 | :newspaper: |
When you update documentations. |
| 🎨 | :art: |
When you write major code modifications. |
| 📝 | :pencil: |
When you perform minor code modifications. |
| 🐎 | :racehorse: |
When you improve code performances. |
| 📚 | :books |
When you write docs on source code. |
| ✨ | :sparkles: |
When you add new features. |
| 🐛 | :bug: |
When fixing a bug |
| ☔: | :umbrella: |
When you write test. |
| 🔥 | :fire: |
When you remove features or file. |
| 🚧 | :construction: |
When you commit code on Work in Progress state. |
| ⬆️ | :arrow_up: |
When upgrading dependencies. |
| ⬇️ | :arrow_down: |
When downgrading dependencies. |
This section is 🚧.
This section is 🚧.