docs: extend contributing guideline

textkernel · Jun 6, 2019 · a63697f · a63697f
1 parent 2114e29
commit a63697f
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -95,6 +95,18 @@ OneUI's [release procedure](RELEASING.md) and [changelog](CHANGELOG.md) automati
 [optional footer]
 ```
 
+Commit types include:
+* `feat`: A new feature
+* `fix`: A bug fix
+* `docs`: Changes to documentation
+* `test`: Changes to tests
+* `chore`: Other changes that dont affect source files, tests or documentation
+* `revert`: Reverted previous commit
+
+Use imperative, present tense in your commit description ("change", not "changed" or "changes") without uppercases or period (.) at the end.
+
+Breaking changes should be explicitly marked (with uppercase) in the message footer, e.g. `BREAKING CHANGE: <note>`.
+
 ### Merging
 When merging a branch, squash its commits for the changelog to be nice and tidy. Each pull request / squashed commit should eventually equal one fix / feature / change in docs or tests.