From 2ede51b3cc5be2ce39b54913f4d05252a5de6b57 Mon Sep 17 00:00:00 2001 From: Danny Fritz Date: Thu, 11 May 2017 14:19:29 -0600 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Unicode=20emoji=20=E2=9C=A8=20Inclu?= =?UTF-8?q?de=20names=20of=20emoji?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- INTEGRATIONS.md | 7 ++-- README.md | 91 ++++++++++++++++++++++++++----------------------- 2 files changed, 50 insertions(+), 48 deletions(-) diff --git a/INTEGRATIONS.md b/INTEGRATIONS.md index 92d1907..8691055 100644 --- a/INTEGRATIONS.md +++ b/INTEGRATIONS.md @@ -15,6 +15,7 @@ Click on the smile face to find and insert emoji. ## Atom Editor Install package for [autocomplete-emojis](https://atom.io/packages/autocomplete-emojis). +In the package settings, check the box for "Enable Unicode Emojis". Atom can also help with using emoji in commit message by installing [git-plus](https://atom.io/packages/git-plus) @@ -32,9 +33,5 @@ Add `set completefunc=emoji#complete` to `.vimrc` and then run emoji completion Create an `.npmrc` [file](https://docs.npmjs.com/files/npmrc) and set the `message` value. ```ini -message = ":bookmark: %s" +message = "🔖 %s" ``` - -## SourceTree - -Not currently available. Vote for this [issue](https://jira.atlassian.com/browse/SRCTREEWIN-3072) to ask for it. diff --git a/README.md b/README.md index 82a8217..99a6b10 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,42 @@ -# Commit Message Emoji +# Commit Message Emoji 👋 Every commit is important. -So let's celebrate each and every commit with a corresponding emoji! :smile: +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. :smirk: +what kind of changes have been made. 😏 ## Usage Prepend every commit message with an emoji with this form: -`:emoji: commit message`. +` commit message`. -## Which Emoji to Use? :confused: +For commits with multiple types of messages, use multiple lines: +``` + commit message + commit message2 +``` + +## Which Emoji to Use? ❓ Commit Type | Emoji ----------- | ------------- -Initial Commit | :tada: `:tada:` -Version Tag | :bookmark: `:bookmark:` -New Feature | :sparkles: `:sparkles:` -Bugfix | :bug: `:bug:` -Metadata | :card_index: `:card_index:` -Refactoring | :recycle: `:recycle:` -Documentation | :books: `:books:` -Internationalization | :globe_with_meridians: `:globe_with_meridians:` -Performance | :racehorse: `:racehorse:` -Cosmetic | :lipstick: `:lipstick:` -Tooling | :wrench: `:wrench:` -Tests | :rotating_light: `:rotating_light:` -Deprecation | :poop: `:poop:` -Work In Progress (WIP) | :construction: `:construction:` -Other | [Be creative](http://www.emoji-cheat-sheet.com/) - -## Using Emoji is Hard! :rage: +---------- | ----- +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/) +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/) +Performance | [🐎 Horse](http://emojipedia.org/horse/) +Cosmetic | [💄 Lipstick](http://emojipedia.org/lipstick/) +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/) +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. @@ -41,7 +46,7 @@ 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 :anguished: +### Commits Without Emoji 😧 0.5.2 @@ -79,40 +84,40 @@ Add shields to README. Add missing methods to index.js. -### Commits with Emoji :smiley: +### Commits with Emoji 😃 -:bookmark: 0.5.2 +🔖 0.5.2 -:bug: Fix exporting of the library to include _.ifElse +🐛 Fix exporting of the library to include _.ifElse -:bookmark: 0.5.1 +🔖 0.5.1 -:books: add _.ifElse to README.md +📚 add _.ifElse to README.md -:bookmark: 0.5.0 +🔖 0.5.0 -:sparkles: add _.ifElse +✨ add _.ifElse -:books: fix JSDoc comment for _.call +📚 fix JSDoc comment for _.call -:books: Fix _.not documentation example. +📚 Fix _.not documentation example. -:books: Update JSDoc comments. +📚 Update JSDoc comments. -:bookmark: 0.4.1 +🔖 0.4.1 -:books: Update links to documentation. +📚 Update links to documentation. -:books: Fix documentation. +📚 Fix documentation. -:books: Link to documentation pages. +📚 Link to documentation pages. -:bookmark: 0.4.0 +🔖 0.4.0 -:sparkles: Added a curried version of the mixin for lodash-fp. +✨ Added a curried version of the mixin for lodash-fp. -:card_index: Switch from lodash to lodash-compat +📇 Switch from lodash to lodash-compat -:card_index: Add shields to README. +📇 Add shields to README. -:bug: Add missing methods to index.js. +🐛 Add missing methods to index.js.