Add automation workflow tip to CONTRIBUTING.md

ekohl · Feb 1, 2021 · 2e5fe3c · 2e5fe3c
1 parent 0365b1a
commit 2e5fe3c
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,7 +2,14 @@
 
 ## Filing and Fixing Issues
 
-All issues are tracked using [Redmine](https://projects.theforeman.org/projects/puppet-foreman/issues). There are two types of issues that may arise:
+All issues are tracked using [Redmine](https://projects.theforeman.org/projects/puppet-foreman/issues).
+
+Where relevant, the first line of a commit message should reference the
+associated Redmine issue to permit automation to work correctly, for example:
+
+`Fixes #31387 - Drop TLS 1.0 and TLS 1.1 from Apache`
+
+There are two types of issues that may arise:
 
   * A bug within an individual module
   * A bug within the hooks or scripts of the installer