Skip to content

Commit 9892477

Browse files
committed
🎉 Initial commit
0 parents commit 9892477

File tree

3 files changed

+146
-0
lines changed

3 files changed

+146
-0
lines changed

INTEGRATIONS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Integrations
2+
3+
There are various ways to make inserting emojis easier.
4+
5+
## Atom Editor
6+
7+
Install packages for [autocomplete-plus](https://atom.io/packages/autocomplete-plus) and [autocomplete-emojis](https://atom.io/packages/autocomplete-emojis).
8+
9+
Atom can also help with using emoji in commit message by installing [git-plus](https://atom.io/packages/git-plus)
10+
11+
## npm
12+
13+
Create an `.npmrc` file and set the `message` value.
14+
```ini
15+
message = ":bookmark: %2"
16+
```
17+
18+
## Sourcetree
19+
20+
Not currently available. Vote for this [issue](https://jira.atlassian.com/browse/SRCTREEWIN-3072) to ask for it.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) <year> <copyright holders>
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.

README.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Commit Message Emoji
2+
3+
Every commit is important.
4+
So let's celebrate each and every commit with a corresponding emoji! :smile:
5+
6+
Oh, and it can also help with glancing over commit messages to figure out
7+
what kind of changes have been made. :smirk:
8+
9+
## Usage
10+
11+
Commit Type | Emoji
12+
---------- | -------------
13+
Initial Commit | :tada:
14+
Version Tag | :bookmark:
15+
New Feature | :sparkles:
16+
Bugfix | :bug:
17+
Metadata | :card_index:
18+
Documentation | :books:
19+
Performance | :racehorse:
20+
Cosmetic | :lipstick:
21+
Tests | :rotating_light:
22+
General Update | :zap:
23+
Other | [Be creative](http://www.emoji-cheat-sheet.com/)
24+
25+
## Comparison
26+
27+
You can be the judge on which is easier to grok.
28+
29+
Example taken from [here](https://github.com/dannyfritz/funcdash/commits/master)
30+
31+
### Commits without Emoji
32+
33+
0.5.2
34+
35+
Fix exporting of the library to include _.ifElse
36+
37+
0.5.1
38+
39+
add _.ifElse to README.md
40+
41+
0.5.0
42+
43+
add _.ifElse
44+
45+
fix JSDoc comment for _.call
46+
47+
Fix _.not documentation example.
48+
49+
Update JSDoc comments.
50+
51+
0.4.1
52+
53+
Update links to documentation.
54+
55+
Fix documentation.
56+
57+
Link to documentation pages.
58+
59+
0.4.0
60+
61+
Added a curried version of the mixin for lodash-fp.
62+
63+
Switch from lodash to lodash-compat
64+
65+
Add shields to README.
66+
67+
Add missing methods to index.js.
68+
69+
### Commits with Emoji
70+
71+
:bookmark: 0.5.2
72+
73+
:bug: Fix exporting of the library to include _.ifElse
74+
75+
:bookmark: 0.5.1
76+
77+
:books: add _.ifElse to README.md
78+
79+
:bookmark: 0.5.0
80+
81+
:sparkles: add _.ifElse
82+
83+
:books: fix JSDoc comment for _.call
84+
85+
:books: Fix _.not documentation example.
86+
87+
:books: Update JSDoc comments.
88+
89+
:bookmark: 0.4.1
90+
91+
:books: Update links to documentation.
92+
93+
:books: Fix documentation.
94+
95+
:books: Link to documentation pages.
96+
97+
:bookmark: 0.4.0
98+
99+
:sparkles: Added a curried version of the mixin for lodash-fp.
100+
101+
:card_index: Switch from lodash to lodash-compat
102+
103+
:card_index: Add shields to README.
104+
105+
:bug: Add missing methods to index.js.

0 commit comments

Comments
 (0)