📝docs: Use of Gitmoji

octoleo · Nov 30, 2024 · b205fa4 · b205fa4
1 parent 5ab04c8
commit b205fa4
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/CONVENTIONAL_COMMIT.md b/CONVENTIONAL_COMMIT.md
@@ -48,3 +48,36 @@ The subject contains succinct description of the change:
 * don't capitalize first letter
 * no dot (.) at the end
 
+
+### Gitmoji Usage
+
+[Gitmoji](https://gitmoji.dev/) provides a visual and expressive way to enhance commit messages by including emojis that represent the intent of the changes. It can be used alongside the Conventional Commit specification to add more clarity and fun to commit history.
+
+Each Gitmoji corresponds to a specific type of change:
+
+| Emoji   | Description                          | Conventional Commit Type   |
+|---------|--------------------------------------|----------------------------|
+| ✨      | Introducing new features             | `feat`                     |
+| 🐛      | Fixing a bug                         | `fix`                      |
+| 📝      | Writing or updating documentation    | `docs`                     |
+| 🎨      | Improving code structure/style       | `style`                    |
+| ♻️      | Refactoring code                    | `refactor`                 |
+| ⚡️      | Improving performance                | `perf`                     |
+| ✅      | Adding or updating tests             | `test`                     |
+| 🔧      | Changes to configuration files       | `chore`                    |
+| 🚀      | Deployment-related changes           | `chore`                    |
+| 🔒      | Fixing security issues               | `fix`                      |
+| 🌱      | Adding or updating a seed file       | `chore`                    |
+| 🔥      | Removing code or files               | `chore`                    |
+
+#### Guidelines for Using Gitmoji
+- Place the corresponding emoji at the beginning of the **description** in the commit message header.
+- Ensure the emoji aligns with the type and purpose of the change.
+- Examples:
+  - `✨feat: add user authentication module`
+  - `🐛fix: resolve issue with null pointer exception`
+  - `🌱chore: add initial database seed script`
+  - `📝docs: update README with installation instructions`
+  - `🔥chore: remove deprecated API endpoints`
+
+Using Gitmoji is optional but can make commit messages more engaging and informative.