From 17f013d167f010cd0166f869af424141605a992b Mon Sep 17 00:00:00 2001 From: Kienan Stewart Date: Fri, 9 Feb 2024 12:08:11 -0500 Subject: [PATCH] Docs: Add the example commit from CONTRIBUTING as a template MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Observed issue ============== I found myself referring to the contributing guide each time a made a new commit to ensure that I had the appropriate style and sections. Solution ======== A stub template `.commit_template` has been added and the instructions in `CONTRIBUTING.md` indicate that the local checkout that be configured to use it as a template for new commits which are made. Known drawbacks =============== None. Change-Id: Idfacd4d726657cb57f193f0a3375a840d8a9c746 Signed-off-by: Kienan Stewart Signed-off-by: Jérémie Galarneau --- .commit_template | 24 ++++++++++++++++++++++++ CONTRIBUTING.md | 5 +++++ 2 files changed, 29 insertions(+) create mode 100644 .commit_template diff --git a/.commit_template b/.commit_template new file mode 100644 index 000000000..b0da31505 --- /dev/null +++ b/.commit_template @@ -0,0 +1,24 @@ +Fix: Short description + +Observed issue +============== + +Steps to reproduce (list of commands or narrative description). + +Cause +===== + +Solution +======== + +Known drawbacks +=============== + +References +========== +[1]: + +Fixes: #xxx +Refs: #yyy + +Signed-off-by: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 696de362a..8b15bea0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,6 +37,11 @@ The mailing list is also used to share and comment on RFCs and answer user questions. +A template commit messsage is available below, and as a file that you may +configure your local check out to use: + + git config commit.template .commit_template + Once your changes have been comitted to your local branch, you may use the [git-review](https://opendev.org/opendev/git-review) plugin to submit them directly to [Gerrit](https://review.lttng.org) using the following command: -- 2.34.1