Docs: Add the example commit from CONTRIBUTING as a template

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 <kstewart@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/.commit_template b/.commit_template
new file mode 100644 (file)
index 0000000..b0da315
--- /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 696de362a30ee4a320831c3587f5aa2e052b16f8..8b15bea0f05b09c8be02148dc21ae14419669e62 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -37,6 +37,11 @@ The mailing list is also used to share and comment on
 <abbr title="Request for Comments">RFC</abbr>s 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: