Skip to content

Commit ba49748

Browse files
authored
Create CONTRIBUTING.md
1 parent 07e1d1e commit ba49748

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Styleguides
2+
3+
### Git Commit Messages
4+
5+
* Use the present tense ("Add feature" not "Added feature")
6+
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
7+
* Limit the first line to 72 characters or less
8+
* Reference issues and pull requests liberally after the first line
9+
* Consider starting the commit message with an applicable emoji:
10+
* :art: `:art:` when improving the format/structure of the code
11+
* :racehorse: `:racehorse:` when improving performance
12+
* :non-potable_water: `:non-potable_water:` when plugging memory leaks
13+
* :memo: `:memo:` when writing docs
14+
* :penguin: `:penguin:` when fixing something on Linux
15+
* :apple: `:apple:` when fixing something on macOS
16+
* :checkered_flag: `:checkered_flag:` when fixing something on Windows
17+
* :bug: `:bug:` when fixing a bug
18+
* :fire: `:fire:` when removing code or files
19+
* :green_heart: `:green_heart:` when fixing the CI build
20+
* :white_check_mark: `:white_check_mark:` when adding tests
21+
* :lock: `:lock:` when dealing with security
22+
* :arrow_up: `:arrow_up:` when upgrading dependencies
23+
* :arrow_down: `:arrow_down:` when downgrading dependencies
24+
* :shirt: `:shirt:` when removing linter warnings

0 commit comments

Comments
 (0)