If you would contribute on the project, you must respect many rules about commit format, pull request or issues.
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 modifications made in project.
- If you post a WiP commit, you MUST indicate it by the emoji 🚧
- Respect Markdown rules.
- Respect emoji description below to indicate the modification made by the commit modification.
| Emoji | Emoji code | Description |
|---|---|---|
| 📰 | :newspaper: |
When you update documentations file (README.md, CONTRIBUTING.md, ...). |
| 🎨 | :art: |
When you write major code modifications. |
| 📝 | :pencil: |
When you perform minor code modifications. |
| 🐎 | :racehorse: |
When improving code performances. |
| 📚 | :books: |
When writting docs on source code. |
| ✨ | :sparkles: |
When adding new features. |
| 🐛 | :bug: |
When fixing a bug |
| ☔: | :umbrella: |
When writing test. |
| 🔥 | :fire: |
When removing features or file. |
| 🚧 | :construction: |
When commiting code on Work in Progress state. |
| 🔧 | :wrench: |
When updating settings or package manager file. |
| ⬆️ | :arrow_up: |
When upgrading dependencies. |
| ⬇️ | :arrow_down: |
When downgrading dependencies. |
| 🔒 | :lock: |
When dealing with security. |
| 💄 | :lipstick: |
When improving UI / Cosmetic. |
| ♿ | :wheelchair: |
When improving accessibility. |
| 🌐 | :globe_with_meridians: |
When dealing with globalization / I18N / G11N. |
| 🎉 | :tada: |
Initial commit. |
| 🔖 | :bookmark: |
Version tags. |
| 🏆 | :trophy: |
New release. |
| 🤝 | :handshake: |
When merging files. |
This section is 🚧.
This section is 🚧.