boo

contributing.md

@@ -17,18 +17,30 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
 2. If you've added code that should be tested, add tests.
 3. If you've added new driver, changed usage, or made some nontrivial changes - update the documentation.
 4. Ensure the test suite passes.
-5. Don't forget to add "Signed-off-by: Your Name <your@email_domain.com>" line in the commit message.
+5. Don't forget to add "Signed-off-by: Your Name <your@email_domain.com>" line in the commit message (`git commit -s`). 
 6. If you are a Red Hat contributor, you MUST include the [Jira](https://issues.redhat.com/) key in the commit message.
 7. If you are NOT a Red Hat contributor, but know of a relevant Jira key, please include it in the commit message.
-8. Prefix commit messages with the Jira key first, then the affected driver, followed by a description.
+9. Create that pull request!
 <details>
-<summary><ins>Examples</ins></summary>
+<summary><ins>Examples of including the Jira key in the commit message</ins></summary>
 <br>
 
-RHELMISC-8923: NetKVM: Implementing dynamic NDIS version support
-RHELMISC-8923: [NetKVM] Implementing dynamic NDIS version support
+Prefix commit messages with the Jira key first, followed by the relevant driver, followed by a short description.
+- RHELMISC-8923: NetKVM: Implementing dynamic NDIS version support
+- RHELMISC-8923: [NetKVM] Implementing dynamic NDIS version support
+
+These can be issued from the command line using the following syntax:
+`git commit -s -m "RHELMISC-8923: [NetKVM] Implementing dynamic NDIS version support" -m "Descriptive content for the body"`
+...or in the system editor, using:
+`git commit -s -e`
+...or use the CLI multiline editor, e.g:
+```
+git commit -s -m "RHELMISC-8923: [NetKVM] Implementing dynamic NDIS version support
+First line body content
+More body content"
+```
+
 </details>
-9. Create that pull request!
 
 
 ## Any contributions you make will be under the BSD 3-Clause License