Skip to content

Commit d640a7b

Browse files
benyamin-codezYanVugenfirer
authored andcommitted
[CI-NO-BUILD] [doco] Update contributing.md re Jira key prefix
1. Emcourage all contibutors to add known Jira keys as a prefix to PRs 2. Expand examples and place in dropdown Signed-off-by: benyamin-codez <115509179+benyamin-codez@users.noreply.github.com>
1 parent 55dc35a commit d640a7b

1 file changed

Lines changed: 32 additions & 4 deletions

File tree

contributing.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,38 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
1717
2. If you've added code that should be tested, add tests.
1818
3. If you've added new driver, changed usage, or made some nontrivial changes - update the documentation.
1919
4. Ensure the test suite passes.
20-
5. Don't forget to add "Signed-off-by: Your Name <your@email_domain.com>" line in the commit message.
21-
6. If you are a Red Hat contributor, you must include [Jira](https://issues.redhat.com/) key in the commit message
22-
7. Prefix commit messages with the Jira key first, and then the affected component. For example: "RHELMISC-8923: NetKVM: implementing dynamic NDIS version support".
23-
8. Issue that pull request!
20+
5. Don't forget to add "Signed-off-by: Your Name <your@email_domain.com>" line in the commit message, e.g. with `git commit -s`
21+
6. If you are a Red Hat contributor, you MUST include the [Jira](https://issues.redhat.com/) key in the commit message.
22+
7. If you are NOT a Red Hat contributor, but know of a relevant Jira key, please include it in the commit message.
23+
8. Push your local commits to the remote branch, e.g. with `git push --branches --verbose`
24+
9. Create that pull request!
25+
<details>
26+
<summary><ins>Examples of including the Jira key in the commit message</ins></summary>
27+
<br>
28+
29+
Prefix commit messages with the Jira key first, followed by a reference to the relevant component, followed by a short description, e.g.:
30+
- RHELMISC-8923: NetKVM: Implementing dynamic NDIS version support
31+
- RHELMISC-8923: [NetKVM] Implementing dynamic NDIS version support
32+
33+
These can be issued from the command line using the following syntax:
34+
```
35+
git commit -s -m "RHELMISC-8923: [NetKVM] Implementing dynamic NDIS version support" -m "First line body content\nMore body content"
36+
```
37+
38+
...or manually in the system editor, using:
39+
```
40+
git commit -s -e
41+
```
42+
43+
...or use the CLI multiline editor, e.g:
44+
```
45+
git commit -s -m "RHELMISC-8923: [NetKVM] Implementing dynamic NDIS version support
46+
First line body content
47+
More body content"
48+
```
49+
50+
In the examples above, the `-s` parameter causes `git` to include the _Signed-off-by_ signature in the commit message.
51+
</details>
2452

2553

2654
## Any contributions you make will be under the BSD 3-Clause License

0 commit comments

Comments
 (0)