https://github.com/jvsmota/.commit-emoji-adder

Script that automatically adds emojis to Git commit messages.
https://github.com/jvsmota/.commit-emoji-adder

bash-script commit-conventions emoji-commits git-commit

Last synced: about 1 month ago
JSON representation

Script that automatically adds emojis to Git commit messages.

• Host: GitHub
• URL: https://github.com/jvsmota/.commit-emoji-adder
• Owner: JVSMOTA
• Created: 2024-08-23T22:58:11.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-11-27T19:31:43.000Z (6 months ago)
• Last Synced: 2025-03-28T09:11:14.505Z (about 2 months ago)
• Topics: bash-script, commit-conventions, emoji-commits, git-commit
• Language: Shell
• Homepage:
• Size: 121 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# .commit-emoji-adder



[![Hits](https://hits.sh/github.com/JVSMOTA/.commit-emoji-adder.svg)](https://hits.sh/github.com/JVSMOTA/.commit-emoji-adder/)  



## 💻 Running example



![Exemplo de execução](https://github.com/user-attachments/assets/bde0ec97-3b05-4115-86fb-e3dafc0e6bde)



## 🛠️ How to install

- Clone the repository into the directory `~/`:

```bash

cd ~ && git clone https://github.com/JVSMOTA/.commit-emoji-adder.git

```

- To install, run the install command:

```bash

~/.commit-emoji-adder/bin/install

```

## 📖 How to use

1. Navigate to the directory of your project that is using Git.

2. When you commit, emojis are automatically added according to the specified commit type. Just follow the standard message structure:

```bash

git commit -m "[scope]: "

```

- **Exemple:** To add a new feature, you can use:

```bash

$ git commit -m "feat: Add new authentication feature"

[master b8a9ca2] ✨ feat: Add new authentication feature

 1 file changed, 0 insertions(+), 0 deletions(-)

```

> [!NOTE]

>

> Note that the `git` script will automatically add the appropriate emoji based on the specified commit type. 

> But if you have any doubts, run to list the commit types and associated emoji:

> 

> ```bash

> git commit -m ?

> ```

> 

> - The list of commit types and their emojis can be customized in the `bin/commit`.

> 

> This usage structure is intended to ensure that your commit messages follow a clear and standardized convention, making it easier for all team members to read and understand your commit history.

> 

## ❌ How to uninstall

> [!WARNING]

> 

> This will remove both the `~/.commit-emoji-adder/` directory and the changes to `~/bashrc`. 

Simply run:

 

```bash

~/.commit-emoji-adder/bin/uninstall

```