| 1 | # Contributing
|
| 2 |
|
| 3 | - Non-trivial changes should be discussed in an issue first
|
| 4 | - Develop in a topic branch, not master
|
| 5 | - Squash your commits
|
| 6 |
|
| 7 | ## Commit Message Format
|
| 8 |
|
| 9 | ```
|
| 10 | TYPE/CONTEXT: SHORT TITLE
|
| 11 |
|
| 12 | DESCRIPTION IN SEVERAL
|
| 13 | LINES IF NEEDED
|
| 14 |
|
| 15 | FOOTER
|
| 16 | ```
|
| 17 |
|
| 18 | | TYPE | MEANING |
|
| 19 | | ------------ | --------------------------------------------------------------------------- |
|
| 20 | | **feature** | new functionality |
|
| 21 | | **refactor** | a change that restructures the code without modifying its external behavior |
|
| 22 | | **fix** | a change that fixes an identified/registered bug |
|
| 23 | | **docs** | a change that adds or updates docs |
|
| 24 | | **style** | coding conventions etc |
|
| 25 | | **test** | test added or update |
|
| 26 |
|
| 27 | | | |
|
| 28 | | ------------- | ----------------------------------------------------------------------------------------------------------- |
|
| 29 | | `TITLE` | Succinct description of the change. - imperative mood, e.g. change, NOT changed or changes - all lower case |
|
| 30 | | `CONTEXT` | (optional) Part of Huncwot affected by change (e.g. cli, server) |
|
| 31 | | `DESCRIPTION` | Motivation for the change using simple English phrases |
|
| 32 | | `FOOTER` | References issues in a ticketing system. |
|
| 33 |
|
| 34 | ### Example
|
| 35 |
|
| 36 | ```
|
| 37 | feature/checkout: add cart functionality
|
| 38 |
|
| 39 | Add cart with checkout process. Integrate payment
|
| 40 | gateway.
|
| 41 |
|
| 42 | Closes #112 #123 #345 [4:00]
|
| 43 | ```
|