Skip to content

Commit f01a664

Browse files
docs: clarify vouch timing, DCO vs signing, and PR checklist guidance (#2810)
Spell out that auto-closed PRs keep their discussion and can be reopened or replaced, separate DCO sign-off from cryptographic commit signing, and say to mark PR checklist items complete only after verification. Signed-off-by: politerealism <burdcat17@gmail.com>
1 parent f6a3983 commit f01a664

1 file changed

Lines changed: 11 additions & 4 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ We use a vouch system. This exists because AI makes it trivial to generate plaus
2727
3. Write in your own words. AI-generated vouch requests will be denied.
2828
4. A maintainer will comment `/vouch` if approved, and the request discussion
2929
will close automatically.
30-
5. Once vouched, you can submit pull requests.
30+
5. **Get vouched before opening a PR.** Once vouched, you can submit pull requests.
3131

32-
**If you are not vouched, any pull request you open will be automatically closed.** Org members and collaborators with push access bypass this check.
32+
**If you are not vouched, any pull request you open will be automatically closed.** The PR and its discussion are preserved. Once vouched, open a new PR (preferred) or reopen the closed one. It cannot be held open or converted to a draft to bypass the check. Org members and collaborators with push access bypass this check.
3333

3434
### Finding Work
3535

@@ -490,10 +490,17 @@ By making a contribution to this project, I certify that:
490490
```
491491

492492
```bash
493-
git commit -s -m "feat(sandbox): add new capability"
493+
git commit --signoff --message "feat(sandbox): add new capability"
494494
```
495495

496-
DCO sign-off is separate from cryptographic commit signing. CI requires signing for org members so that copy-pr-bot can mirror your PR automatically; see [CI.md](CI.md#commit-signing) for setup.
496+
DCO sign-off is separate from cryptographic commit signing, and the two have different requirements:
497+
498+
- **DCO sign-off** (`--signoff`) adds the `Signed-off-by` trailer to each commit. It applies to every contributor. The DCO Assistant bot also asks you to sign the DCO once, by commenting on your PR.
499+
- **Cryptographic commit signing** applies to org members and collaborators only. CI requires it so that copy-pr-bot can mirror your PR automatically; see [CI.md](CI.md#commit-signing) for setup.
500+
501+
### PR testing checklist
502+
503+
Only mark a checklist item as complete after you have run and verified it, not as a plan for what you intend to test. Unchecked boxes at submission are fine; they show what still needs verification before merge.
497504

498505
## CI
499506

0 commit comments

Comments
 (0)