Gitmoji

https://gitmoji.dev

Admin

Gitmoji is an emoji guide for GitHub commit messages that provides a standardized way to identify...

Tokens:1,068

Snippets:87

Trust Score:9.6

Update:5 months ago

Show doc for...

Tokens:

Raw

### Install gitmoji-cli

Source: https://gitmoji.dev/about

Install the gitmoji-cli globally to use gitmoji from your command line. This tool provides an interactive client for using emojis in commit messages.

```bash
$ npm i -g gitmoji-cli
```

--------------------------------

### Example Gitmoji Commit Messages

Source: https://gitmoji.dev/specification

Illustrative examples of Gitmoji commit messages using various emojis and scopes.

```text
⚡️ Lazyload home screen images.
```

```text
🐛 Fix `onClick` event handler
```

```text
🔖 Bump version `1.2.0`
```

```text
♻️ (components): Transform classes to hooks
```

```text
📈 Add analytics to the dashboard
```

```text
🌐 Support Japanese language
```

```text
♿️ (account): Improve modals a11y
```

--------------------------------

### Gitmoji Commit Message Format

Source: https://gitmoji.dev/specification

The standard format for a Gitmoji commit message. The scope is optional and can be enclosed in parentheses. A colon can optionally follow the scope.

```text
<intention> [scope?][:?] <message>
```

Tokens:

Raw