Skip to content

chore: document issue-first workflow in CONTRIBUTING.md - #2827

Open
cdesiniotis wants to merge 1 commit into
NVIDIA:mainfrom
cdesiniotis:issue-first-req-in-contributing-guide
Open

chore: document issue-first workflow in CONTRIBUTING.md#2827
cdesiniotis wants to merge 1 commit into
NVIDIA:mainfrom
cdesiniotis:issue-first-req-in-contributing-guide

Conversation

@cdesiniotis

Copy link
Copy Markdown
Contributor

Description

This addresses SIG-CON-07 from the OSS Scorecard.

Checklist

  • No secrets, sensitive information, or unrelated changes
  • Lint checks passing (make lint)
  • Generated assets in-sync (make validate-generated-assets)
  • Go mod artifacts in-sync (make validate-modules)
  • Test cases are added for new code paths

Testing

OSS scorecard was run with and without this change.

@cdesiniotis

Copy link
Copy Markdown
Contributor Author

Canceling the GHA to save some electricity ⚡.

@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The 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 fdf58

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 @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 win

Align the timing with GOVERNANCE.md.

GOVERNANCE.md:55-66 requires 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

📥 Commits

Reviewing files that changed from the base of the PR and between fa49ea6 and fdf5823.

📒 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>
@cdesiniotis
cdesiniotis force-pushed the issue-first-req-in-contributing-guide branch from fdf5823 to ff20b58 Compare August 28, 2026 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants