From: paumr <paum@bdisk.eu>
Date: Mon, 21 Oct 2024 16:27:22 +0000 (+0200)
Subject: doc: added commit conventions to contribution guidelines
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=5d96ed0eedb94bce6c71acc7c6b6a3398e8aace6;p=users%2Fsagi%2Fnvme-cli.git

doc: added commit conventions to contribution guidelines

Show new contributors the project's commit guidelines

Signed-off-by: paumr <paum@bdisk.eu>
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cde85273..df0e8e5e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,6 +19,28 @@ Please feel free to use the github forums to ask for comments & questions on
 your code before submitting a pull request.  The NVMe CLI project uses the
 common *fork and merge* workflow used by most GitHub-hosted projects.
 
+#### Commit conventions
+
+The project follows the Linux kernel mailing list workflow,
+thus commit messages should be structured like this:
+```
+<feature|plugin|subject>: <commit message>
+
+<description of the feature>
+
+Signed-off-by: My Name/alias <email@address.foo>
+```
+
+Example:
+
+```
+doc: added commit conventions to contribution guidelines
+
+Show new contributors the project's commit guidelines
+
+Signed-off-by: John Doe <j.doe@address.foo>
+```
+
 ### Bug Reports
 
 Bugs for the NVM Library project are tracked in our [GitHub Issues Database](https://github.com/linux-nvme/nvme-cli/issues).