├── LICENSE ├── INTEGRATIONS.md └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2017 Danny Fritz 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /INTEGRATIONS.md: -------------------------------------------------------------------------------- 1 | # Integrations 2 | 3 | There are various ways to make inserting emojis easier. 4 | 5 | ## OSX 6 | 7 | You can pull up the emoji keyboard by hitting ctrl+⌘+space 8 | 9 | ## Windows 10 10 | 11 | You can pull up the emoji keyboard by hitting Win+. 12 | 13 | ## Ubuntu 20 14 | 15 | You can press Super to search for the emoji name, but only the first 5 matches are displayed. This works for "book", but not for "bug". 16 | 17 | ![Ubuntu Focal Fossa emoji search](https://user-images.githubusercontent.com/33569/82133882-d0ff1f00-97a5-11ea-9d8e-97fdf7dd41da.png) 18 | 19 | 20 | ## Ubuntu (all versions) 21 | 22 | Launch the "Characters" application. 23 | 24 | ![Characters](https://user-images.githubusercontent.com/33569/82133860-7bc30d80-97a5-11ea-9d91-33ad8caab611.png) 25 | 26 | ## Gnome Shell 27 | 28 | You can show a list of emoji to copy to your system clipboard using the [Emoji Selector](https://extensions.gnome.org/extension/1162/emoji-selector/) Gnome extension. This extension [recognises commit message emoji labels](https://github.com/maoschanz/emoji-selector-for-gnome/pull/80) like 'refactor', 'version', 'wip'. 29 | 30 | ## Atom Editor 31 | 32 | Install package for [autocomplete-emojis](https://atom.io/packages/autocomplete-emojis). 33 | In the package settings, check the box for "Enable Unicode Emojis". 34 | 35 | Atom can also help with using emoji in commit message by installing [git-plus](https://atom.io/packages/git-plus) 36 | 37 | ## Sublime Text 38 | 39 | Install package for [GithubEmoji](https://github.com/akatopo/GithubEmoji). 40 | 41 | ## Vim 42 | 43 | Install package for [Vim-emoji](https://github.com/junegunn/vim-emoji#installation). 44 | 45 | Add `set completefunc=emoji#complete` to `.vimrc` and then run emoji completion with `CTRL-X CTRL-U` 46 | 47 | ## npm 48 | 49 | Create an `.npmrc` [file](https://docs.npmjs.com/files/npmrc) and set the `message` value. 50 | ```ini 51 | message = "🔖 %s" 52 | ``` 53 | 54 | ## Emacs 55 | 56 | Install [emoji-cheat-sheet-plus](https://github.com/syl20bnr/emacs-emoji-cheat-sheet-plus). 57 | 58 | Bring up the emoji buffer with: 59 | 60 | ``` 61 | M-x emoji-cheat-sheet-plus-insert 62 | ``` 63 | 64 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Commit Message Emoji 👋 2 | 3 | Every commit is important. 4 | So let's celebrate each and every commit with a corresponding emoji! 😄 5 | 6 | Oh, and it can also help with glancing over commit messages to figure out 7 | what kind of changes have been made. 😏 8 | 9 | ## Usage 10 | 11 | Prepend every commit message with an emoji with this form: 12 | ` commit message`. 13 | 14 | For commits with multiple types of messages, use multiple lines: 15 | ``` 16 | commit message 17 | commit message2 18 | ``` 19 | 20 | ## Which Emoji to Use? ❓ 21 | 22 | Commit Type | Emoji 23 | ---------- | ----- 24 | Initial Commit | [🎉 Party Popper](http://emojipedia.org/party-popper/) 25 | Version Tag | [🔖 Bookmark](http://emojipedia.org/bookmark/) 26 | New Feature | [✨ Sparkles](http://emojipedia.org/sparkles/) 27 | Bugfix | [🐛 Bug](http://emojipedia.org/bug/) 28 | Security Fix | [🔒 Lock](https://emojipedia.org/lock/) 29 | Metadata | [📇 Card Index](http://emojipedia.org/card-index/) 30 | Refactoring | [♻️ Black Universal Recycling Symbol](http://emojipedia.org/black-universal-recycling-symbol/) 31 | Documentation | [📚 Books](http://emojipedia.org/books/) 32 | Internationalization | [🌐 Globe With Meridians](http://emojipedia.org/globe-with-meridians/) 33 | Accessibility | [♿ Wheelchair](https://emojipedia.org/wheelchair-symbol/) 34 | Performance | [🐎 Horse](http://emojipedia.org/horse/) 35 | Cosmetic | [🎨 Artist Palette](http://emojipedia.org/artist-palette/) 36 | Tooling | [🔧 Wrench](http://emojipedia.org/wrench/) 37 | Tests | [🚨 Police Cars Revolving Light](http://emojipedia.org/police-cars-revolving-light/) 38 | Deprecation | [💩 Pile of Poo](http://emojipedia.org/pile-of-poo/) 39 | Removal | [🗑️ Wastebasket](http://emojipedia.org/wastebasket/) 40 | Work In Progress (WIP) | [🚧 Construction Sign](http://emojipedia.org/construction-sign/) 41 | 42 | ## Using Emoji is Hard! 😡 43 | 44 | Here are [some ways](INTEGRATIONS.md) to more easily integrate emoji into your workflow. 45 | 46 | ## Comparison 47 | 48 | You can be the judge on which is easier to grok. 49 | 50 | Example taken from [here](https://github.com/dannyfritz/funcdash/commits/master) 51 | 52 | ### Commits Without Emoji 😧 53 | 54 | 0.5.2 55 | 56 | Fix exporting of the library to include _.ifElse 57 | 58 | 0.5.1 59 | 60 | add _.ifElse to README.md 61 | 62 | 0.5.0 63 | 64 | add _.ifElse 65 | 66 | fix JSDoc comment for _.call 67 | 68 | Fix _.not documentation example. 69 | 70 | Update JSDoc comments. 71 | 72 | 0.4.1 73 | 74 | Update links to documentation. 75 | 76 | Fix documentation. 77 | 78 | Link to documentation pages. 79 | 80 | 0.4.0 81 | 82 | Added a curried version of the mixin for lodash-fp. 83 | 84 | Switch from lodash to lodash-compat 85 | 86 | Add shields to README. 87 | 88 | Add missing methods to index.js. 89 | 90 | ### Commits with Emoji 😃 91 | 92 | 🔖 0.5.2 93 | 94 | 🐛 Fix exporting of the library to include _.ifElse 95 | 96 | 🔖 0.5.1 97 | 98 | 📚 add _.ifElse to README.md 99 | 100 | 🔖 0.5.0 101 | 102 | ✨ add _.ifElse 103 | 104 | 📚 fix JSDoc comment for _.call 105 | 106 | 📚 Fix _.not documentation example. 107 | 108 | 📚 Update JSDoc comments. 109 | 110 | 🔖 0.4.1 111 | 112 | 📚 Update links to documentation. 113 | 114 | 📚 Fix documentation. 115 | 116 | 📚 Link to documentation pages. 117 | 118 | 🔖 0.4.0 119 | 120 | ✨ Added a curried version of the mixin for lodash-fp. 121 | 122 | 📇 Switch from lodash to lodash-compat 123 | 124 | 📇 Add shields to README. 125 | 126 | 🐛 Add missing methods to index.js. 127 | --------------------------------------------------------------------------------