diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 76a468b..aeff2a9 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -9,9 +9,10 @@ or any other method with the owners of this repository before making a change. These are the most important things to know before contributing (also explained in more detail later in this document): - Commit messages must adhere to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). -- Branch names must be formatted correctly. The format is `{category}/GH-{issue number}/{lowercase-description}`. +- Branch names must be formatted correctly. The format is `{category}/GH-{issue number}/{lowercase-description}`. You + can also use `NO-ISSUE` instead of a GitHub issue number. Category must match a - category [used in our Commitlint config](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum). You can also use `NO-ISSUE` instead of a GitHub issue number. + category [used in our Commitlint config](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum). - We use [Checkstyle](https://checkstyle.sourceforge.io/) in our build workflow to validate coding style. It is recommended to import the [config/checkstyle/checkstyle.xml](../config/checkstyle/checkstyle.xml) or [config/intellij-code-style.xml](../config/intellij-code-style.xml) file into your