Skip to content

Commit cad580c

Browse files
Copilotmarosset
authored andcommitted
Fix markdown linting issues in CONTRIBUTING.md and add markdownlint config
Co-authored-by: marosset <[email protected]> Signed-off-by: Simon Davies <[email protected]>
1 parent f51e9dc commit cad580c

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

.markdownlint.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"default": true,
3+
"MD013": false
4+
}

CONTRIBUTING.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This project welcomes contributions. Most contributions require you to signoff o
44
the Developer Certificate of Origin (DCO). When you submit a pull request, a DCO-bot will automatically determine
55
whether you need to provide signoff for your commit. Please follow the instructions provided by DCO-bot, as pull
66
requests cannot be merged until the author(s) have provided signoff to fulfill the DCO requirement.
7-
You may find more information on the DCO requirements [below](#developer-certificate-of-origin-signing-your-work).
7+
You may find more information on the DCO requirements [below](#developer-certificate-of-origin-and-gpg-signing).
88

99
## Issues
1010

@@ -31,7 +31,7 @@ All contributions come through pull requests. To submit a proposed change, we re
3131
- Code changes require tests
3232
- Make sure to run the linters to check and format the code
3333
4. Update relevant documentation for the change
34-
5. Commit with [DCO sign-off](#developer-certificate-of-origin-signing-your-work) and open a PR
34+
5. Commit with [DCO sign-off](#developer-certificate-of-origin-and-gpg-signing) and open a PR
3535
6. Wait for the CI process to finish and make sure all checks are green
3636
7. A maintainer of the project will be assigned, and you can expect a review within a few days
3737

@@ -51,7 +51,8 @@ This project requires two types of signatures on all commits:
5151
**For DCO Sign-offs:**
5252

5353
The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the [DCO](https://developercertificate.org/), reformatted for readability:
54-
```
54+
55+
```text
5556
By making a contribution to this project, I certify that:
5657
5758
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
@@ -82,17 +83,20 @@ git commit -s -m 'This is my commit message'
8283
GPG signatures verify the identity of the committer. To set up GPG signing:
8384

8485
1. Generate a GPG key and configure Git to use it:
86+
8587
```sh
8688
git config --global user.signingkey YOUR_KEY_ID
8789
git config --global commit.gpgsign true
8890
```
8991

9092
2. Sign commits with the `-S` flag (or rely on the automatic signing from the above configuration):
93+
9194
```sh
9295
git commit -S -m 'This is my signed commit message'
9396
```
9497

9598
3. For both DCO sign-off and GPG signature in one command:
99+
96100
```sh
97101
git commit -S -s -m 'This is my signed and signed-off commit message'
98102
```
@@ -101,18 +105,20 @@ For detailed instructions on setting up both signature types, see [docs/commit-s
101105

102106
Each Pull Request is checked to ensure all commits contain valid DCO sign-offs and GPG signatures.
103107

104-
#### I didn't sign my commit, now what?!
108+
#### I didn't sign my commit, now what?
105109

106110
No worries - You can easily replay your changes, sign them and force push them!
107111

108112
**For adding both DCO sign-off and GPG signature:**
113+
109114
```sh
110115
git checkout <branch-name>
111116
git commit --amend --no-edit -S -s
112117
git push --force-with-lease <remote-name> <branch-name>
113118
```
114119

115120
**For fixing multiple commits:**
121+
116122
```sh
117123
git rebase -i HEAD~n # Replace n with the number of commits to fix
118124
# Change 'pick' to 'edit' for each commit

0 commit comments

Comments
 (0)