Skip to content

Commit 9183b0d

Browse files
authored
Merge pull request #3217 from riscv/3216-add-signed-off-by-requirement-for-commits-to-contributingmd
Added information regarding adding Signed-off-by to commits.
2 parents cd56f79 + ad99965 commit 9183b0d

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Outputs land in the `build/` directory.
6767
- Create a branch for your change.
6868
- Keep commits focused and include clear messages.
6969
- Run the relevant build target(s) before opening a PR.
70+
- Sign off your commit with `git commit -s` or add `git config --global format.signOff true` to your global git config.
7071
- Open a pull request with a short summary of what changed and why.
7172

7273
## PR checklist (as applicable)
@@ -92,10 +93,20 @@ NOTE: New RISC-V specifications may only be developed by RISC-V International me
9293

9394
## Sign your commits
9495

95-
All contributions must be signed. Use either SSH (recommended) or GPG.
96+
All contributions must be signed with a `Signed-off-by: Name <email>` and a cryptographic key using either SSH (recommended) or GPG.
9697

9798
# Signing GitHub Commits — Step by Step
9899

100+
## REQUIRED: Sign off your commits with a `Signed-off-by: Name <email>` in the commit message.
101+
102+
This can be achieved with `git commit -s` or automating it by adding `git config --global format.signOff true` to your global git config file.
103+
104+
Note that the Developer's Certificate of Origin bot that RISC-V employs across all of it's repositories requires the `Signed-off-by:` trailer exists. If it's missing, Pull Requests will fail the DCO Check and will not be accepted.
105+
106+
# Signing Git Commits with your Signing Key
107+
108+
In addition to adding the DCO Signed-off-by line to your commits, your commits must be signed with your private key, and your public key must be uploaded to GitHub as a signing key.
109+
99110
## Option A: Sign commits with SSH (recommended)
100111

101112
### 1. Generate an SSH key (skip if you already have one)

0 commit comments

Comments
 (0)