|
| 1 | +# Contributing to Band-aid |
| 2 | + |
| 3 | +:bulb::tada: First off, thanks for taking the time to contribute! :tada::bulb: |
| 4 | + |
| 5 | +## Table Of Contents |
| 6 | + |
| 7 | +[Styleguides](#styleguides) |
| 8 | + |
| 9 | +* [Branch names](#branch-names) |
| 10 | +* [Git Commit Messages](#git-commit-messages) |
| 11 | +* [Documentation Styleguide](#documentation-styleguide) |
| 12 | + |
| 13 | +## Styleguides |
| 14 | + |
| 15 | +### Branch names |
| 16 | + |
| 17 | +* The branch name all starts with [fix, add, remove, refactor] |
| 18 | + |
| 19 | +### Git Commit Messages |
| 20 | + |
| 21 | +* Limit the first line to 72 characters or less |
| 22 | +* Use the present tense ("Add feature" not "Added feature") |
| 23 | +* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") |
| 24 | +* Reference issues and pull requests liberally after the first line |
| 25 | +* Consider starting the commit message with an applicable emoji |
| 26 | + * :new: `:new:` when add code or file(s) |
| 27 | + * :poop: `:poop:` when add code or file(s) that needs refactor later |
| 28 | + * :art: `:art:` when improving the format/structure of the code |
| 29 | + * :rocket: `:rocket:` when improving performance |
| 30 | + * :book: `:book:` when writing docs |
| 31 | + * :abc: `:abc:` when renamining or fixing syntax errors |
| 32 | + * :bug: `:bug:` when fixing a bug |
| 33 | + * :fire: `:fire:` when removing code or file(s) |
| 34 | + * :green_heart: `:green_heart:` when fixing the CI build |
| 35 | + * :traffic_light: `:traffic_light:` when adding tests |
| 36 | + * :arrow_up: `:arrow_up:` when upgrading dependencies |
| 37 | + * :arrow_down: `:arrow_down:` when downgrading dependencies |
| 38 | + * :x: `:x:` when removing dependencies |
| 39 | + * :shirt: `:shirt:` when improving or fixing linters |
| 40 | + |
| 41 | +### Documentation Styleguide |
| 42 | + |
| 43 | +* Use [CHANGELOG.md](CHANGELOG.md) to doc your changes. |
0 commit comments