Skip to content

Commit 5d96ed0

Browse files
paumrigaw
authored andcommitted
doc: added commit conventions to contribution guidelines
Show new contributors the project's commit guidelines Signed-off-by: paumr <paum@bdisk.eu>
1 parent 63548a8 commit 5d96ed0

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,28 @@ Please feel free to use the github forums to ask for comments & questions on
1919
your code before submitting a pull request. The NVMe CLI project uses the
2020
common *fork and merge* workflow used by most GitHub-hosted projects.
2121

22+
#### Commit conventions
23+
24+
The project follows the Linux kernel mailing list workflow,
25+
thus commit messages should be structured like this:
26+
```
27+
<feature|plugin|subject>: <commit message>
28+
29+
<description of the feature>
30+
31+
Signed-off-by: My Name/alias <email@address.foo>
32+
```
33+
34+
Example:
35+
36+
```
37+
doc: added commit conventions to contribution guidelines
38+
39+
Show new contributors the project's commit guidelines
40+
41+
Signed-off-by: John Doe <j.doe@address.foo>
42+
```
43+
2244
### Bug Reports
2345

2446
Bugs for the NVM Library project are tracked in our [GitHub Issues Database](https://github.com/linux-nvme/nvme-cli/issues).

0 commit comments

Comments
 (0)