Skip to content

Commit 2ede51b

Browse files
committed
✨ Unicode emoji
✨ Include names of emoji
1 parent 6349d94 commit 2ede51b

File tree

2 files changed

+50
-48
lines changed

2 files changed

+50
-48
lines changed

INTEGRATIONS.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Click on the smile face to find and insert emoji.
1515
## Atom Editor
1616

1717
Install package for [autocomplete-emojis](https://atom.io/packages/autocomplete-emojis).
18+
In the package settings, check the box for "Enable Unicode Emojis".
1819

1920
Atom can also help with using emoji in commit message by installing [git-plus](https://atom.io/packages/git-plus)
2021

@@ -32,9 +33,5 @@ Add `set completefunc=emoji#complete` to `.vimrc` and then run emoji completion
3233

3334
Create an `.npmrc` [file](https://docs.npmjs.com/files/npmrc) and set the `message` value.
3435
```ini
35-
message = ":bookmark: %s"
36+
message = "🔖 %s"
3637
```
37-
38-
## SourceTree
39-
40-
Not currently available. Vote for this [issue](https://jira.atlassian.com/browse/SRCTREEWIN-3072) to ask for it.

README.md

Lines changed: 48 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,42 @@
1-
# Commit Message Emoji
1+
# Commit Message Emoji 👋
22

33
Every commit is important.
4-
So let's celebrate each and every commit with a corresponding emoji! :smile:
4+
So let's celebrate each and every commit with a corresponding emoji! 😄
55

66
Oh, and it can also help with glancing over commit messages to figure out
7-
what kind of changes have been made. :smirk:
7+
what kind of changes have been made. 😏
88

99
## Usage
1010

1111
Prepend every commit message with an emoji with this form:
12-
`:emoji: commit message`.
12+
`<emoji> commit message`.
1313

14-
## Which Emoji to Use? :confused:
14+
For commits with multiple types of messages, use multiple lines:
15+
```
16+
<emoji> commit message
17+
<emoji2> commit message2
18+
```
19+
20+
## Which Emoji to Use? ❓
1521

1622
Commit Type | Emoji
17-
---------- | -------------
18-
Initial Commit | :tada: `:tada:`
19-
Version Tag | :bookmark: `:bookmark:`
20-
New Feature | :sparkles: `:sparkles:`
21-
Bugfix | :bug: `:bug:`
22-
Metadata | :card_index: `:card_index:`
23-
Refactoring | :recycle: `:recycle:`
24-
Documentation | :books: `:books:`
25-
Internationalization | :globe_with_meridians: `:globe_with_meridians:`
26-
Performance | :racehorse: `:racehorse:`
27-
Cosmetic | :lipstick: `:lipstick:`
28-
Tooling | :wrench: `:wrench:`
29-
Tests | :rotating_light: `:rotating_light:`
30-
Deprecation | :poop: `:poop:`
31-
Work In Progress (WIP) | :construction: `:construction:`
32-
Other | [Be creative](http://www.emoji-cheat-sheet.com/)
33-
34-
## Using Emoji is Hard! :rage:
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+
Metadata | [📇 Card Index](http://emojipedia.org/card-index/)
29+
Refactoring | [♻️ Black Universal Recycling Symbol](http://emojipedia.org/black-universal-recycling-symbol/)
30+
Documentation | [📚 Books](http://emojipedia.org/books/)
31+
Internationalization | [🌐 Globe With Meridians](http://emojipedia.org/globe-with-meridians/)
32+
Performance | [🐎 Horse](http://emojipedia.org/horse/)
33+
Cosmetic | [💄 Lipstick](http://emojipedia.org/lipstick/)
34+
Tooling | [🔧 Wrench](http://emojipedia.org/wrench/)
35+
Tests | [🚨 Police Cars Revolving Light](http://emojipedia.org/police-cars-revolving-light/)
36+
Deprecation | [💩 Pile of Poo](http://emojipedia.org/pile-of-poo/)
37+
Work In Progress (WIP) | [🚧 Construction Sign](http://emojipedia.org/construction-sign/)
38+
39+
## Using Emoji is Hard! 😡
3540

3641
Here are [some ways](INTEGRATIONS.md) to more easily integrate emoji into your workflow.
3742

@@ -41,7 +46,7 @@ You can be the judge on which is easier to grok.
4146

4247
Example taken from [here](https://github.com/dannyfritz/funcdash/commits/master)
4348

44-
### Commits Without Emoji :anguished:
49+
### Commits Without Emoji 😧
4550

4651
0.5.2
4752

@@ -79,40 +84,40 @@ Add shields to README.
7984

8085
Add missing methods to index.js.
8186

82-
### Commits with Emoji :smiley:
87+
### Commits with Emoji 😃
8388

84-
:bookmark: 0.5.2
89+
🔖 0.5.2
8590

86-
:bug: Fix exporting of the library to include _.ifElse
91+
🐛 Fix exporting of the library to include _.ifElse
8792

88-
:bookmark: 0.5.1
93+
🔖 0.5.1
8994

90-
:books: add _.ifElse to README.md
95+
📚 add _.ifElse to README.md
9196

92-
:bookmark: 0.5.0
97+
🔖 0.5.0
9398

94-
:sparkles: add _.ifElse
99+
add _.ifElse
95100

96-
:books: fix JSDoc comment for _.call
101+
📚 fix JSDoc comment for _.call
97102

98-
:books: Fix _.not documentation example.
103+
📚 Fix _.not documentation example.
99104

100-
:books: Update JSDoc comments.
105+
📚 Update JSDoc comments.
101106

102-
:bookmark: 0.4.1
107+
🔖 0.4.1
103108

104-
:books: Update links to documentation.
109+
📚 Update links to documentation.
105110

106-
:books: Fix documentation.
111+
📚 Fix documentation.
107112

108-
:books: Link to documentation pages.
113+
📚 Link to documentation pages.
109114

110-
:bookmark: 0.4.0
115+
🔖 0.4.0
111116

112-
:sparkles: Added a curried version of the mixin for lodash-fp.
117+
Added a curried version of the mixin for lodash-fp.
113118

114-
:card_index: Switch from lodash to lodash-compat
119+
📇 Switch from lodash to lodash-compat
115120

116-
:card_index: Add shields to README.
121+
📇 Add shields to README.
117122

118-
:bug: Add missing methods to index.js.
123+
🐛 Add missing methods to index.js.

0 commit comments

Comments
 (0)