dannyfritz / commit-message-emoji Goto Github PK

View Code? Open in Web Editor NEW

1.5K 23.0 181.0 19 KB

Every commit is important. So let's celebrate each and every commit with a corresponding emoji! :smile:

License: MIT License

commit-message-emoji's Introduction

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: <emoji> commit message.

For commits with multiple types of messages, use multiple lines:

<emoji> commit message
<emoji2> commit message2

Which Emoji to Use? ❓

Commit Type	Emoji
Initial Commit	🎉 Party Popper
Version Tag	🔖 Bookmark
New Feature	✨ Sparkles
Bugfix	🐛 Bug
Security Fix	🔒 Lock
Metadata	📇 Card Index
Refactoring	♻️ Black Universal Recycling Symbol
Documentation	📚 Books
Internationalization	🌐 Globe With Meridians
Accessibility	♿ Wheelchair
Performance	🐎 Horse
Cosmetic	🎨 Artist Palette
Tooling	🔧 Wrench
Tests	🚨 Police Cars Revolving Light
Deprecation	💩 Pile of Poo
Removal	🗑️ Wastebasket
Work In Progress (WIP)	🚧 Construction Sign

Using Emoji is Hard! 😡

Here are some ways to more easily integrate emoji into your workflow.

Comparison

You can be the judge on which is easier to grok.

Example taken from here

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.

commit-message-emoji's People

Contributors

Stargazers

Watchers

Forkers

antoninslejska isaaclessard anisdjer d-s-x annahuffman147 elanalynn bpjackson irobsc apexskier cmcnamara87 mani-mishra marloxo apedyashev viztushar posva tbleckert cagataycali stevenleelawson brujo-rojas jarydkrish anuja-joshi vitojeng dratto josephj bertoort ellerbrock anilpai liyao maltejanosch marszall87 mapledyne jim3ma scopsy yaitloutou jeremistadler jeancsanchez nathanmalishev sa-odell luizhenriqueleme m9rco akai willrstern jedsada-gh katanaaa newyork-anthonyng torrepaul315 antoine-aumjaud russandrussky zhythero doelia benoitrongeard wesvetter zaurbek quantummob opeadeyomoye oliboy50 jorns tsmall weichiachang lebsral saady bouchaaraadil wataash erltrax fkei marianneredp yennefer carlos-ea italopessoa deisingj1 rsginer xpol belemaire anderson-liu benjaminbest lintanghui xionzhao kniveditha danilomiranda fdenzer nawsen tapaniatportland t0mab dsymquen ridgekimani lahsrah schubidu ghisleouf gnnng kayandra hemanik yemartin ryanrw germanny sharminator slimlime veekram moham96 felipm13 b7s9

commit-message-emoji's Issues

what is 'tooling'?

I'm confused as to what the Tooling commit message means.
Thanks

Security fixes emoji

Is there a specific emoji for security fixes? I know "all bugs can be a security bug" but that would be nice to have one too ;-)

It should be cool to add the real unicode name in front of emoji in the table.
Indeed, on mac we can't find the Party popperemoji (:tada:) with the keyword tada.
http://emojipedia.org/party-popper/

Thx !