chore: document issue-first workflow in CONTRIBUTING.md - #2827
chore: document issue-first workflow in CONTRIBUTING.md#2827cdesiniotis wants to merge 1 commit into
Conversation
|
Canceling the GHA to save some electricity ⚡. |
📝 WalkthroughWalkthroughThe Contributions section now requires contributors to open an issue before submitting pull requests for significant changes. Significant changes include architectural changes, new features, breaking API or behavior changes, and non-trivial bug fixes. Merge Risk: 🔵 Low · up to The documentation adds an issue-first workflow, but its timing may allow implementation before an issue is opened, conflicting with the project’s governance guidance. The PR is mergeable with explicit owner awareness or a follow-up to align the wording. Comment |
There was a problem hiding this comment.
Note
Quiet mode is enabled, so only the most important comments were posted inline. Other review comments are grouped below.
🟡 Other comments (1)
CONTRIBUTING.md-82-83 (1)
82-83: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winAlign the timing with
GOVERNANCE.md.
GOVERNANCE.md:55-66requires a proposal before implementation work begins. These lines require an issue only before opening the pull request. A contributor could therefore implement a significant change without an issue and still satisfy this text. State that the issue must be opened before implementation begins, or explicitly require it before both implementation and the pull request.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: QUIET
Plan: Enterprise
Run ID: 4d67401e-54a0-4a44-a2d6-fba92ffba4ac
📒 Files selected for processing (1)
CONTRIBUTING.md
Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.
This addresses SIG-CON-07 from the OSS Scorecard. Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
fdf5823 to
ff20b58
Compare
Description
This addresses SIG-CON-07 from the OSS Scorecard.
Checklist
make lint)make validate-generated-assets)make validate-modules)Testing
OSS scorecard was run with and without this change.