From 2ed51685b9685d7f16ae42402a4e5cd9acef0de1 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Mon, 15 Jul 2019 17:40:56 +0100 Subject: [PATCH] ;doc: contrib: commit message conventions [ci skip] --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fff14757d..5ede3bbae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -619,6 +619,12 @@ so think about future developers trying to understand them, git bisect, etc. Rebase your commits against latest master for easiest review. Especially if they start to conflict. +Some conventions we often use in commit messages: + +- prepend a [component](#components) prefix, eg `cli: ` or `journal: `, for clarity and to help with changelog production +- prepend a semicolon (`;`) to indicate boring commits that won't affect changelogs/release notes (as in the Emacs project) +- add a final `[ci skip]` line for commits which probably don't need to trigger a CI build, to reduce carbon emissions from Travis + ### The docs PRs should include appropriate updates to reference documentation, unless otherwise agreed.