github.com/git-chglog/git-chglog@v0.15.5-0.20240126074033-6a6993d52d69/CONTRIBUTING.md (about) 1 # Contributing `git-chglog` 2 3 Thank you for contributing `git-chglog` :tada: 4 5 ## Templates 6 7 Please use issue/PR templates which are inserted automatically. 8 9 ## Found a Bug? 10 11 If you find a bug in the source code, you can help us by [submitting an issue] 12 to our [GitHub Repository]. Even better, you can submit a Pull Request with a 13 fix. 14 15 ## Commit Message Format 16 17 A format influenced by [Angular commit message]. 18 19 ```text 20 <type>: <subject> 21 <BLANK LINE> 22 <body> 23 <BLANK LINE> 24 <footer> 25 ``` 26 27 ### Type 28 29 Must be one of the following: 30 31 - **docs:** Documention only changes 32 - **ci:** Changes to our CI configuration files and scripts 33 - **chore:** Updating Makefile etc, no production code changes 34 - **feat:** A new feature 35 - **fix:** A bug fix 36 - **perf:** A code change that improves performance 37 - **refactor:** A code change that neither fixes a bug nor adds a feature 38 - **style:** Changes that do not affect the meaning of the code 39 - **test:** Adding missing tests or correcting existing tests 40 41 ### Footer 42 43 The footer should contain a [closing reference to an issue] if any. 44 45 The **footer** should contain any information about **Breaking Changes** and is 46 also the place to reference GitHub issues that this commit **Closes**. 47 48 **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space 49 or two newlines. The rest of the commit message is then used for this. 50 51 [submitting an issue]: https://github.com/git-chglog/git-chglog/issues 52 [GitHub Repository]: https://github.com/git-chglog/git-chglog 53 [Angular commit message]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-format 54 [closing reference to an issue]: https://help.github.com/articles/closing-issues-via-commit-messages/