Skip to content

Commit c343969

Browse files
authored
πŸ“š Update CONTRIBUTING.md
1 parent f9b5e28 commit c343969

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

β€ŽCONTRIBUTING.mdβ€Ž

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -100,40 +100,40 @@ To have emojis automatically inserted into your commits when you type a keyword,
100100
./Utilities/setup.sh
101101
```
102102

103-
This will setup a git hook that will parse keywords into emojis when you make a commit.
103+
This will setup a git hook that will parse keywords between `:` into emojis when you make a commit.
104104

105105
For example, comitting
106106

107107
```
108-
:initial: Created a new nibble!
108+
:initial: :feature: Created a new nibble!
109109
```
110110

111111
Will result in the git hook converting the commit message to
112112

113113
```
114-
πŸŽ‰ Created a new nibble!
114+
πŸŽ‰ ✨ Created a new nibble!
115115
```
116116

117117
Below is a list of supported keywords, along with their associated usages and emojis
118118

119119
| Emoji | Keyword | Usage |
120120
|-------|-------------------|------------------------------------------------|
121-
| πŸ› | :bug: | Indicates a bug fix. |
122-
| 🧹 | :cleanup: | Indicates a small cleanup of code. |
123-
| πŸ“¦ | :dependency: | Indicates the addition of a dependency. |
124-
| πŸ“š | :docs: | Indicates documentation updates. |
125-
| ✨ | :feauture: | Indicates a new feature. |
126-
| πŸ›  | :fixup: | Indicates a quick tweak of code. |
127-
| πŸŽ‰ | :initial: | Indicates an initial commit of a project. |
128-
| 🏎 | :performance: | Indicates improvements to performance. |
129-
| ♻️ | :refactor: | Indicates code refactoring. |
130-
| πŸ—‘οΈ | :removal: | Indicates the removal of code. |
131-
| πŸ”’ | :security: | Indicates a security fix. |
132-
| 🎨 | :styling: | Indicates changes to code styling. |
133-
| πŸ”– | :tag: | Indicates a tag for a version. |
134-
| πŸ§ͺ | :tests: | Indicates test related work. |
135-
| 🧰 | :tooling: | Indicates changes to tooling (Such as Actions) |
136-
| 🚧 | :wip: | Indicates work that is in-progress. |
121+
| πŸ› | bug | Indicates a bug fix. |
122+
| 🧹 | cleanup | Indicates a small cleanup of code. |
123+
| πŸ“¦ | dependency | Indicates the addition of a dependency. |
124+
| πŸ“š | docs | Indicates documentation updates. |
125+
| ✨ | feauture | Indicates a new feature. |
126+
| πŸ›  | fixup | Indicates a quick tweak of code. |
127+
| πŸŽ‰ | initial | Indicates an initial commit of a project. |
128+
| 🏎 | performance | Indicates improvements to performance. |
129+
| ♻️ | refactor | Indicates code refactoring. |
130+
| πŸ—‘οΈ | removal | Indicates the removal of code. |
131+
| πŸ”’ | security | Indicates a security fix. |
132+
| 🎨 | styling | Indicates changes to code styling. |
133+
| πŸ”– | tag | Indicates a tag for a version. |
134+
| πŸ§ͺ | tests | Indicates test related work. |
135+
| 🧰 | tooling | Indicates changes to tooling (Such as Actions) |
136+
| 🚧 | wip | Indicates work that is in-progress. |
137137

138138

139139
## Attribution

0 commit comments

Comments
Β (0)