[doc-only] docs: clarify contributor coordination and issue readiness by rwgk · Pull Request #3103 · NVIDIA/cuda-python

rwgk · 2026-10-14T06:00:44Z

Description

Clarify when external contributors should coordinate before implementation, while keeping direct PRs for small standalone fixes without an existing issue and normal self-assignment for NVIDIA contributors.

Component pages and the PR template point to CONTRIBUTING.md. AGENTS.md adds a brief reminder to explain unmet external coordination before implementation.

Validation

Pre-commit checks on all six changed files and git diff --check passed.

Checklist

Documentation is up to date; no runtime changes.
After approval: replace [no-ci] with [doc-only] to run documentation CI. Keep [no-ci] during review to conserve runner capacity.

Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

copy-pr-bot · 2026-10-14T06:00:47Z

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.

coderabbitai · 2026-10-14T06:16:12Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Last reviewed commit: a39f7da
Latest commit, not reviewed: 9cabba7

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

No actionable comments were generated in the recent review.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: NVIDIA/cuda-python/.coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 5e979420-9876-408e-b000-affdc1ac691f

📥 Commits

Reviewing files that changed from the base of the PR and between bafae11 and a39f7da.

📒 Files selected for processing: 3

cuda_bindings/docs/source/contribute.rst
cuda_core/docs/source/contribute.rst
cuda_pathfinder/docs/source/contribute.rst

🚧 Files skipped from review as they are similar to previous changes: 3

cuda_bindings/docs/source/contribute.rst
cuda_pathfinder/docs/source/contribute.rst
cuda_core/docs/source/contribute.rst

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 10 remain after this review.

📝 Summary

Summary by CodeRabbit

Documentation
- Expanded contributor guidance for reporting issues, proposing solutions, coordinating implementation, and handling small or large changes.
- Clarified maintainer agreement, readiness checks, authorized scope, validation, review, authorship, privacy, and coding-agent contribution expectations.
- Updated contribution pages to direct readers to the repository-wide guide and document issue coordination, commit sign-off, and commit-signing requirements.
- Updated the pull request template to clarify issue-link expectations and coding-agent disclosure requirements.

The pull request expands contribution guidance for issue reporting, coordination, authorization, readiness, validation, coding-agent contributions, and pull requests. Component contribution pages now reference the shared guidance.

Changes: Contribution Guidance

Layer / File(s)	Summary
Scope and reporting `AGENTS.md`, `CONTRIBUTING.md`	Defines issue reporting, authorized scope, maintainer coordination, contribution procedures, and contributor-service expectations.
Issue readiness and infrastructure `AGENTS.md`, `CONTRIBUTING.md`	Defines readiness notices, approved scope, validation requirements, optimization tradeoffs, privacy boundaries, and direction changes.
Documentation and agent workflow `.github/PULL_REQUEST_TEMPLATE.md`, `CONTRIBUTING.md`, `cuda_*/docs/source/contribute.rst`	Updates the pull request template, adds coding-agent requirements, and routes component contribution pages to the shared guide.

Suggested reviewers: kkraus14

Priority: Low

Change: Other

Merge Risk: Minimal · previous review a39f7

No contribution-guidance issue requiring a change before merge is established by the supplied evidence.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

_{Comment @coderabbitai help to get the list of available commands.}

Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

Rewrite the front of CONTRIBUTING.md around a short decision list for external contributors: define the term once, move the NVIDIA note to the end of the section, name the small standalone fix exception, describe readiness notices from the reader's side, and add what contributors can expect from maintainers in return. Restructure the matching AGENTS.md section so agents explain the applicable step briefly, before any implementation effort is spent. Bring the three component contribute pages and the PR template in line with the guide, add the missing Secret Scanning entry to the table of contents, and give the footnote link an anchor target. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository: NVIDIA/cuda-python/.coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: f394c96b-a413-4770-b717-79af93222dab

📥 Commits

Reviewing files that changed from the base of the PR and between 30941a2 and bafae11.

📒 Files selected for processing: 6

.github/PULL_REQUEST_TEMPLATE.md
AGENTS.md
CONTRIBUTING.md
cuda_bindings/docs/source/contribute.rst
cuda_core/docs/source/contribute.rst
cuda_pathfinder/docs/source/contribute.rst

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

The component contribute pages introduced the four-step summary as if it applied to everyone, while CONTRIBUTING.md scopes the assignment and coordination steps to contributors from outside NVIDIA. Say so in the lead-in, using the guide's own wording, so the pages and the guide agree. Suggested by CodeRabbit on PR NVIDIA#3103. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

mdboom

Overall, I really like this concept and I think we really need it, but it's way too verbose to accept as-is.

I think:

"Contributors should be assigned to an issue before working on it. Internal contributors may self-assign. External contributors should start a discussion to work out the details and confirm the issue is ready. They will then be assigned to the issue and can work on it."

Everything else seems like noise and I am especially concerned about telling the AGENT to get involved in this coordination and human hand-off.

mdboom · 2026-10-28T14:51:57Z

+## Who the coordination step applies to
+
+The assignment and maintainer-agreement requirements apply to external
+contributors, meaning anyone contributing from outside NVIDIA. NVIDIA
+colleagues coordinate through the team's internal planning and maintainer
+direction; do not add a separate permission or assignment step for them. Use
+the affiliation the user states or that is already established in the
+session. If it is unclear, describe the external requirements conditionally,
+for example "if you are contributing from outside NVIDIA, ...". Do not assume
+external status, and do not pause authorized local work to establish
+affiliation. Quality, validation, review, and publication-authorization
+expectations apply to everyone.


This is the only part I would suggest removing -- internal contributors can just self-assign so it all seems moot.

mdboom · 2026-10-28T14:52:54Z

+## Have the conversation early
+
+Before helping an external contributor choose an issue, volunteer for one, or
+start an implementation intended for a PR, check the issue's readiness notice,
+assignment, labels, and maintainer discussion, and tell the contributor which
+of these applies:
+
+- Maintainer agreement already exists: the issue is assigned to them, or a
+  maintainer explicitly asked for the change. Proceed.
+- The change is a [small standalone
+  fix](CONTRIBUTING.md#small-standalone-fixes). A direct PR is fine; suggest
+  linking any existing issue.
+- Coordination is still needed. Suggest the concrete next step, such as a
+  comment asking to take the issue, a reproducer, or a short scope and
+  validation proposal, and offer to help prepare it.
+
+Keep this brief and friendly: two or three sentences, specific to the issue at
+hand, framed as saving the contributor's time rather than as a rule they
+tripped over. For example: "This issue is still marked as a maintainer
+investigation, so a PR would be premature. A reproducer or a short scope
+proposal in the issue would help move it along; I can draft either." Give the
+explanation before implementation effort is spent. Reading the rules silently,
+or pointing to them after the patch is complete, is too late. Do not repeat
+coordination that is already established in the session.


Why are these instructions for the main maintainer in an AGENTS.md? I don't think the agents should be doing this step.

Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

Record the broader small-fix exception for comparison with the simpler assignment-first policy. Existing assignments, pending volunteers, and readiness notices still require maintainer coordination. Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

This reverts commit 7d95e95. Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

…nting" section.

github-actions · 2026-10-28T18:49:18Z

Doc Preview CI
Preview removed because the pull request was closed or merged.

Removed preview folders for the following PRs: - PR #3103 - PR #3170 - PR #3224 - PR #3241 - PR #3250 - PR #3263 - PR #3264 - PR #3270

rwgk added 2 commits October 11, 2026 10:00

docs: clarify contribution coordination and issue readiness

d767a5d

Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

Merge branch 'main' into rwgk/contributor-review-coordination

c6a9bc5

rwgk added this to the cuda.core next milestone Oct 14, 2026

rwgk added documentation Improvements or additions to documentation cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module cuda.pathfinder Everything related to the cuda.pathfinder module labels Oct 14, 2026

rwgk self-assigned this Oct 14, 2026

rwgk changed the title ~~docs: clarify contributor coordination and issue readiness~~ [no-ci] docs: clarify contributor coordination and issue readiness Oct 14, 2026

rwgk marked this pull request as ready for review October 14, 2026 06:11

Merge branch 'main' into rwgk/contributor-review-coordination

a7c2f6f

rwgk added the PR review get-together Mark PRs you'd like the team to review at the weekly PR review get-together. label Oct 17, 2026

rwgk and others added 3 commits October 20, 2026 10:44

Merge branch 'main' into rwgk/contributor-review-coordination

30941a2

docs: clarify early guidance for external contributors

6a05b22

Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

github-actions Bot added the CI/CD CI/CD infrastructure label Oct 20, 2026

coderabbitai Bot reviewed Oct 20, 2026

View reviewed changes

Comment thread cuda_bindings_13/docs/source/contribute.rst Outdated

rwgk removed the PR review get-together Mark PRs you'd like the team to review at the weekly PR review get-together. label Oct 20, 2026

rwgk and others added 2 commits October 20, 2026 14:26

Merge branch 'main' into rwgk/contributor-review-coordination

fe23487

rwgk added the PR review get-together Mark PRs you'd like the team to review at the weekly PR review get-together. label Oct 26, 2026

rwgk mentioned this pull request Oct 28, 2026

pathfinder: add locate_nvidia_dynamic_lib and find_nvidia_dynamic_lib #3233

Closed

mdboom requested changes Oct 28, 2026

View reviewed changes

rwgk added 5 commits October 28, 2026 08:22

Merge branch 'main' into rwgk/contributor-review-coordination

d7b60a9

docs: simplify contributor coordination guidance

5387aa2

Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

Revert "docs: allow small fixes for unclaimed existing issues"

980cd31

This reverts commit 7d95e95. Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

docs: explain unmet contribution coordination before implementation

d9bb6fb

Signed-off-by: Ralf W. Grosse-Kunstleve <rgrossekunst@nvidia.com>

rwgk removed the PR review get-together Mark PRs you'd like the team to review at the weekly PR review get-together. label Oct 28, 2026

Manual pass reducing and polishing the new "Coordinate before impleme…

17c7109

…nting" section.

mdboom approved these changes Oct 28, 2026

View reviewed changes

rwgk changed the title ~~[no-ci] docs: clarify contributor coordination and issue readiness~~ [doc-only] docs: clarify contributor coordination and issue readiness Oct 28, 2026

Merge branch 'main' into rwgk/contributor-review-coordination

9cabba7

rwgk enabled auto-merge (squash) October 28, 2026 18:35

rwgk merged commit 6fff1e5 into NVIDIA:main Oct 28, 2026
33 of 34 checks passed

github-actions Bot pushed a commit that referenced this pull request Oct 29, 2026

Clean up PR preview folders for 8 closed/merged PRs

fb6a8ee

Removed preview folders for the following PRs: - PR #3103 - PR #3170 - PR #3224 - PR #3241 - PR #3250 - PR #3263 - PR #3264 - PR #3270

Navigation Menu

Repository navigation

[doc-only] docs: clarify contributor coordination and issue readiness - #3103

[doc-only] docs: clarify contributor coordination and issue readiness#3103
rwgk merged 15 commits into
NVIDIA:mainfrom
rwgk:rwgk/contributor-review-coordination

rwgk commented Oct 14, 2026 •

edited

Loading

Uh oh!

copy-pr-bot Bot commented Oct 14, 2026

Uh oh!

coderabbitai Bot commented Oct 14, 2026 •

edited

Loading

Reviews paused

Summary by CodeRabbit

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

mdboom left a comment •

edited

Loading

Uh oh!

mdboom Oct 28, 2026

Uh oh!

mdboom Oct 28, 2026

Uh oh!

github-actions Bot commented Oct 28, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

rwgk commented Oct 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Validation

Checklist

Uh oh!

copy-pr-bot Bot commented Oct 14, 2026

Uh oh!

coderabbitai Bot commented Oct 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Summary by CodeRabbit

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mdboom left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mdboom Oct 28, 2026

Choose a reason for hiding this comment

Uh oh!

mdboom Oct 28, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Oct 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rwgk commented Oct 14, 2026 •

edited

Loading

coderabbitai Bot commented Oct 14, 2026 •

edited

Loading

mdboom left a comment •

edited

Loading

github-actions Bot commented Oct 28, 2026 •

edited

Loading