https://github.com/lucas-scandido/commitmoji

An extension to make your commits easier, with emojis and predefined conventions. Ideal for maintaining a more visually organized and informative commit history.
https://github.com/lucas-scandido/commitmoji

commit commit-message conventional-commits emoji extension vscode vscode-extension

Last synced: 5 days ago
JSON representation

An extension to make your commits easier, with emojis and predefined conventions. Ideal for maintaining a more visually organized and informative commit history.

• Host: GitHub
• URL: https://github.com/lucas-scandido/commitmoji
• Owner: lucas-scandido
• Created: 2025-02-04T21:47:37.000Z (8 days ago)
• Default Branch: main
• Last Pushed: 2025-02-05T15:42:33.000Z (7 days ago)
• Last Synced: 2025-02-05T16:39:30.286Z (7 days ago)
• Topics: commit, commit-message, conventional-commits, emoji, extension, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=lucas-scandido.commitmoji
• Size: 55.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# CommitMoji - Emojis and Predefined Conventions

Make your commits easier, with emojis and predefined conventions. Ideal for maintaining a more visually organized and informative commit history.

![Usage example](./img/usage_example.gif)

## 🚀 Features

- Quick selection of emojis with descriptions for commit conventions.

- Direct integration with the commit field in VSCode.

## 📋 Available Emojis

| Emoji | Convention              | Description                          |

|-------|-------------------------|-------------------------------------|

| 🎉    | `Inicial setup`         | Initial project setup                                  |

| 🏗️    | `build`                 | Build system or dependency changes                     |

| 🔧    | `chore`                 | Other changes (e.g., build scripts, config files)      |

| 👷‍♂️    | `ci`                    | CI/CD changes                                          |

| 📖    | `docs`                  | Documentation changes                                  |

| 🚀    | `feat`                  | A new feature                                          |

| 🐛    | `fix`                   | A bug fix                                              |

| ⚡    | `perf`                  | Performance improvements                               |

| 🛠️    | `refactor`              | Code refactoring                                       |

| 🔙    | `revert`                | Revert a previous commit                               |

| 🎨    | `style`                 | Code style changes (e.g., formatting)                  |

| 🧪    | `test`                  | Adding or updating testss                              |

## 🤔 How to Use

2. **Installation** 

    - Search and install the "Commitmoji" extension through the "Extension" menu (Ctrl + Shift + X).

2. **Commite the Changes** 

    - After making any changes, open the "Source Control" menu (Crtl + Shift + G).

    - Add changes to the "Staged Changes" list.

    - Click on the "Commitmoji" icon.

    - Choose the appropriate convection.

    - Press "Enter" or "Click" on the desired convention.

3. **Ready**  

    - Just add the message and commit. 😊

## 📄 Licence

This project is under the MIT License.