docs: clarify vouch timing, DCO vs signing, Cargo feature conventions - #2810
docs: clarify vouch timing, DCO vs signing, Cargo feature conventions#2810politerealism wants to merge 2 commits into
Conversation
|
Thanks for improving the contributor guide, @politerealism ! A few thoughts: DCO vs. signing clarification: Good catch. The distinction between Vouch timing warning: The added detail about losing the discussion thread is helpful context. Small wording note: "Wait for approval before opening a PR" could be read as "don't even prepare your code." Something like "Get vouched before opening a PR" might be more precise, since contributors can (and should) prepare their work locally while waiting. Cargo feature conventions: This section is quite specific to Rust packaging and doesn't match the scope of the rest of CONTRIBUTING.md, which covers project-wide conventions for all contributors (TypeScript, Python, Rust, Go, Helm, docs). The transitive dependency auditing advice ( wdyt ? |
|
Love the recommendations. I will get those changes done |
- Strengthen vouch timing guidance: explicitly note that auto-closed PRs lose their discussion thread and must be manually reopened - Clarify DCO vs. cryptographic signing: both are separate requirements with separate failure modes; --signoff is universal, GPG signing is org-member-only for copy-pr-bot mirroring - Add Cargo feature conventions section covering feature vs. build mode distinction, transitive dependency auditing, and CI verification - Add PR testing checklist guidance: only mark items complete after actual verification, not as a plan No issue required: documentation-only clarifications to contributor workflow derived from observed friction in recent PRs. Signed-off-by: politerealism <burdcat17@gmail.com>
- Expand -m to --message in the DCO commit example for consistency with --signoff. - Rephrase vouch step 5 from "Wait for approval" to "Get vouched" to clarify that contributors can prepare code locally while waiting. - Move Cargo feature conventions out of CONTRIBUTING.md (too language-specific for a project-wide guide) into architecture/build.md under the existing Build Features section, rewritten in prose style to match that document's conventions. Signed-off-by: politerealism <burdcat17@gmail.com>
7ab64c1 to
d671004
Compare
Summary
--signoffis universal for all contributors, GPG signing is org-member-only for copy-pr-bot mirroringcargo tree -e features), and the need for CI verification beyond compile-time guardsRelated Issue
No issue required: documentation-only clarifications to contributor workflow, derived from observed friction in recent PRs.
Changes
CONTRIBUTING.md: four targeted additions to the First-Time Contributors, DCO, Pull Requests, and new Cargo feature conventions sectionsTesting
mise run pre-commitpasses cleanChecklist