docs(contributing): add contribution intake and decision record - #9667
Conversation
Signed-off-by: Will Curran <wcurran@nvidia.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review. 📝 WalkthroughWalkthroughThe contribution request template now requires proposal scope, ownership, placement, support, validation, compatibility, and security details. ChangesContribution process
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This change only updates contribution intake and maintainer guidance; no actionable merge-blocking risk remains after normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
prekshivyas
left a comment
There was a problem hiding this comment.
Draft review for commit 48da715009818ae0d1be76a2ff6fabdcb0f46dfb against base 01e0b92645a68d4ff772dce20ee5758def7211cc.
The feature-request form is scoped to planning evidence, permits explained unknown/not-applicable answers, warns against disclosing sensitive information, and preserves the direct PR path for small documentation changes and low-risk fixes. I found one actionable policy ambiguity in CONTRIBUTING.md: the implementation gate is phrased as applying only when the recorded decision is already Accept, so the other recorded outcomes appear to satisfy the preceding requirement and permit work. The inline rewrite makes Accept itself a prerequisite.
Validation: pre-commit run check-yaml --files .github/ISSUE_TEMPLATE/feature_request.yml passed; npx markdownlint-cli2 CONTRIBUTING.md passed; git diff --check passed. No runtime, credential, dependency, authorization, cryptography, or deployment behavior changes are present. I am leaving a comment rather than approval while the PR remains a draft.
| - **Accountable maintainer:** Name one maintainer when the decision is `Accept`. Use `Not applicable` when the decision is not `Accept`. | ||
| - **Validation plan:** List the required validation evidence when the decision is `Accept`. Use `Not applicable` when the decision is not `Accept`. | ||
|
|
||
| Contributors must not implement a substantive contribution with an `Accept` decision until the record names one accountable maintainer and an explicit validation plan. |
There was a problem hiding this comment.
[P2] Make Accept a prerequisite for implementation
As written, this forbids implementation only with an Accept decision until the other fields exist. Combined with line 85, a recorded Request changes, Defer, or Decline can be read as satisfying the decision-before-work gate. State the intended positive gate directly: “Contributors must not start implementing a substantive contribution until a maintainer records Accept, names one accountable maintainer, and states an explicit validation plan.”
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall line coverage in commit 7547c48 in the TypeScript / code-coverage/cliThe overall line coverage in commit 7547c48 in the Show a line coverage summary of the most impacted files.
Updated |
Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>
Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>
PR Review Advisor — Blocking findings reportedAdvisor assessment: Blockers require maintainer review Model lanes
Second-opinion terminology and E2E selections are advisory. Live E2E does not run automatically for pull requests. 2 semantic terminology decisionsTerminology decisions are advisory. They affect the assessment only when a separate finding identifies concrete semantic impact.
E2E guidanceAdvisory only. A maintainer can dispatch the default E2E suite for the commit under review. Recommended E2E: None Blockers
|
Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>
|
Documentation and contribution-workflow review complete.
The remaining gates are the fresh required checks and any new actionable review feedback. |
apurvvkumaria
left a comment
There was a problem hiding this comment.
Approved after the contribution-workflow, documentation-writing, security, and validation review recorded above. Fresh CI and later actionable feedback remain merge gates.
Summary
Feature requests now collect the planning details maintainers need before implementation starts.
CONTRIBUTING.mdnow defines the matching maintainer decision record while preserving the direct pull request path for small documentation changes and low-risk fixes.Related Issue
Closes #9659
Supports #8498
Changes
Not applicableorUnknownanswers.Type of Change
Quality Gates
DGX Station Hardware Evidence
Verification
Signed-off-by:line and every commit appears asVerifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passed, ornpm run validate:prpassed after refreshingorigin/mainwhen hooks were skipped or unavailablecheck-yamlandmarkdownlint-cli2passed.npm testfor broad runtime/test-harness changes;npm run checkfor repo-wide validation/coverage changes — command/result:npm run docsbuilds without warnings (doc changes only)Documentation build:
npm run docspassed with 0 errors and 2 warnings.Signed-off-by: Will Curran wcurran@nvidia.com
Summary by CodeRabbit