github.com/fredbi/git-chglog@v0.0.0-20190706071416-d35c598eac81/CONTRIBUTING.md (about)

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