Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dannyfritz/commit-message-emoji
Every commit is important. So let's celebrate each and every commit with a corresponding emoji! :smile:
https://github.com/dannyfritz/commit-message-emoji
Last synced: 11 days ago
JSON representation
Every commit is important. So let's celebrate each and every commit with a corresponding emoji! :smile:
- Host: GitHub
- URL: https://github.com/dannyfritz/commit-message-emoji
- Owner: dannyfritz
- License: mit
- Created: 2015-03-18T00:55:00.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-03-05T18:03:20.000Z (over 3 years ago)
- Last Synced: 2024-08-02T02:13:50.637Z (3 months ago)
- Homepage:
- Size: 18.6 KB
- Stars: 1,548
- Watchers: 22
- Forks: 181
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Commit Message Emoji 👋
Every commit is important.
So let's celebrate each and every commit with a corresponding emoji! 😄
Oh, and it can also help with glancing over commit messages to figure out
what kind of changes have been made. 😏
## Usage
Prepend every commit message with an emoji with this form:
` commit message`.
For commits with multiple types of messages, use multiple lines:
```
commit message
commit message2
```
## Which Emoji to Use? ❓
Commit Type | Emoji
---------- | -----
Initial Commit | [🎉 Party Popper](http://emojipedia.org/party-popper/)
Version Tag | [🔖 Bookmark](http://emojipedia.org/bookmark/)
New Feature | [✨ Sparkles](http://emojipedia.org/sparkles/)
Bugfix | [🐛 Bug](http://emojipedia.org/bug/)
Security Fix | [🔒 Lock](https://emojipedia.org/lock/)
Metadata | [📇 Card Index](http://emojipedia.org/card-index/)
Refactoring | [♻️ Black Universal Recycling Symbol](http://emojipedia.org/black-universal-recycling-symbol/)
Documentation | [📚 Books](http://emojipedia.org/books/)
Internationalization | [🌐 Globe With Meridians](http://emojipedia.org/globe-with-meridians/)
Accessibility | [♿ Wheelchair](https://emojipedia.org/wheelchair-symbol/)
Performance | [🐎 Horse](http://emojipedia.org/horse/)
Cosmetic | [🎨 Artist Palette](http://emojipedia.org/artist-palette/)
Tooling | [🔧 Wrench](http://emojipedia.org/wrench/)
Tests | [🚨 Police Cars Revolving Light](http://emojipedia.org/police-cars-revolving-light/)
Deprecation | [💩 Pile of Poo](http://emojipedia.org/pile-of-poo/)
Removal | [🗑️ Wastebasket](http://emojipedia.org/wastebasket/)
Work In Progress (WIP) | [🚧 Construction Sign](http://emojipedia.org/construction-sign/)
## Using Emoji is Hard! 😡
Here are [some ways](INTEGRATIONS.md) to more easily integrate emoji into your workflow.
## Comparison
You can be the judge on which is easier to grok.
Example taken from [here](https://github.com/dannyfritz/funcdash/commits/master)
### Commits Without Emoji 😧
0.5.2
Fix exporting of the library to include _.ifElse
0.5.1
add _.ifElse to README.md
0.5.0
add _.ifElse
fix JSDoc comment for _.call
Fix _.not documentation example.
Update JSDoc comments.
0.4.1
Update links to documentation.
Fix documentation.
Link to documentation pages.
0.4.0
Added a curried version of the mixin for lodash-fp.
Switch from lodash to lodash-compat
Add shields to README.
Add missing methods to index.js.
### Commits with Emoji 😃
🔖 0.5.2
🐛 Fix exporting of the library to include _.ifElse
🔖 0.5.1
📚 add _.ifElse to README.md
🔖 0.5.0
✨ add _.ifElse
📚 fix JSDoc comment for _.call
📚 Fix _.not documentation example.
📚 Update JSDoc comments.
🔖 0.4.1
📚 Update links to documentation.
📚 Fix documentation.
📚 Link to documentation pages.
🔖 0.4.0
✨ Added a curried version of the mixin for lodash-fp.
📇 Switch from lodash to lodash-compat
📇 Add shields to README.
🐛 Add missing methods to index.js.