From b205fa44602ae03be31af56b68e8984b0a0e9b86 Mon Sep 17 00:00:00 2001 From: PlantUML Date: Sat, 30 Nov 2024 14:11:32 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9Ddocs:=20Use=20of=20Gitmoji?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONVENTIONAL_COMMIT.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/CONVENTIONAL_COMMIT.md b/CONVENTIONAL_COMMIT.md index 31e797a248a..dd099c39e34 100644 --- 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.