Skip to content

[no-ci] Update CONTRIBUTING.md to include instructions about coderabbit - #3189

Merged
jpascucci-nv merged 5 commits into
NVIDIA:mainfrom
jpascucci-nv:issue2137-3
Oct 26, 2026
Merged

jpascucci-nv merged 5 commits into
NVIDIA:mainfrom
jpascucci-nv:issue2137-3

Conversation

@jpascucci-nv

@jpascucci-nv jpascucci-nv commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

[no-ci]

Description

closes #2137

Added the text from CCCL's coderabbit.rst to our CONTRIBUTING.md, per #2137 's rollout step 4.

Checklist

  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

closes NVIDIA#2137

Added the text from CCCL's coderabbit.rst to our CONTRIBUTING.md
@jpascucci-nv
jpascucci-nv requested review from rparolin and rwgk October 22, 2026 17:54
@jpascucci-nv jpascucci-nv self-assigned this Oct 22, 2026
@jpascucci-nv jpascucci-nv added documentation Improvements or additions to documentation bug Something isn't working P1 Medium priority - Should do and removed bug Something isn't working labels Oct 22, 2026
@coderabbitai

coderabbitai Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

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.

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
Commits

Reviewing files that changed from the base of the PR and between f72a09e and 2fd84a6.

Files selected for processing: 2
  • .github/CODERABBIT.md
  • CONTRIBUTING.md

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

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Expanded the contribution guide with CodeRabbit review guidance, including how to request a review or full review and use commands for help, configuration, summaries, pausing, resuming, and disabling automatic reviews.
    • Added guidance on how CodeRabbit configuration is selected for same-repository and fork pull requests, inspecting or exporting settings, repository settings, and path-specific instructions.
    • Clarified that review comments are advisory and provided guidance for keeping configuration focused on high-impact issues while avoiding noisy comments.

The pull request adds CodeRabbit review guidance to CONTRIBUTING.md and adds .github/CODERABBIT.md with repository configuration and review guidance.

Changes: CodeRabbit contribution guidance

Layer / File(s) Summary
Document CodeRabbit review workflow
CONTRIBUTING.md, .github/CODERABBIT.md
The contribution guide links to CodeRabbit guidance and describes review commands and maintainer evaluation of feedback. The repository guide describes configuration behavior, commands, and review guidance.

Assessment against linked issues

Objective Addressed Explanation
Enable automatic reviews with the requested .coderabbit.yaml configuration [#2137] ❌ The change does not add .coderabbit.yaml or enable automatic reviews.
Document the maintainer review workflow, including manual review, pause/resume, opt-out, and resolved configuration [#2137] ✅

Priority: Low

Change: Other

Merge Risk: Minimal · up to 2fd84

The documentation-only change has no established merge-blocking risk.

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

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.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between c968fcc and 2691bfa.

📒 Files selected for processing: 1
  • CONTRIBUTING.md

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

Comment thread CONTRIBUTING.md Outdated
@jpascucci-nv jpascucci-nv added the cuda.core Everything related to the cuda.core module label Oct 22, 2026
@github-actions

github-actions Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor
Doc Preview CI
Preview removed because the pull request was closed or merged.

@rwgk rwgk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Me:

I wonder, is CONTRIBUTING.md the best home for the added information?

It seems more like information for maintainers, not contributors?

codex GPT-6.1-Sol ultra:

I found one documentation issue:

  • [P2] Qualify which branch supplies configuration. Lines 250–251 say the PR branch’s configuration is used. CodeRabbit’s command reference says fork PRs use the target branch’s configuration. Mention that exception so contributors don’t expect configuration changes in a fork to affect their review.

On placement, I agree with you. Configuration, noise policy, and maintainer review responsibilities fit better in maintainer documentation. Issue #2137 explicitly requests that, and the source material lives under CCCL’s docs/maintainers/.

I’d move the detailed section into .github/CODERABBIT.md, following the existing maintainer runbook precedent. Keep a short note in CONTRIBUTING.md explaining that CodeRabbit feedback is advisory, with a link to the operational guidance.

No other issues found. Documentation-only review; no files changed or tests run.

@rwgk rwgk changed the title Update CONTRIBUTING.md to include instructions about coderabbit [no-ci] Update CONTRIBUTING.md to include instructions about coderabbit Oct 22, 2026
@rwgk

rwgk commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

I added [no-ci] to the PR title, since this PR only touches only .md files.

@jpascucci-nv

Copy link
Copy Markdown
Contributor Author

@rwgk That's where Rob told me to put it. I'll update the doc for the P2 issue, though.

@rwgk

rwgk commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

@rwgk That's where Rob told me to put it. I'll update the doc for the P2 issue, though.

I believe it'll be quite distracting for contributors. @rparolin WDYT about following the .github/RELEASE-core.md precedent?

@jpascucci-nv

Copy link
Copy Markdown
Contributor Author

@rwgk That's where Rob told me to put it. I'll update the doc for the P2 issue, though.

I believe it'll be quite distracting for contributors. @rparolin WDYT about following the .github/RELEASE-core.md precedent?

The section that says "Pull Request Reviews" and "Review Guidance" is actually for contributors to know how they can control coderabbit. It's really only the Configuration section that makes sense to be moved, maybe.

@jpascucci-nv jpascucci-nv 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
@github-actions github-actions Bot added the CI/CD CI/CD infrastructure label Oct 26, 2026
@jpascucci-nv

Copy link
Copy Markdown
Contributor Author

@rwgk Updated as we discussed in the meeting.

@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.

Actionable comments posted: 1


Review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 8ee9fce and d84fbd7.

Files selected for processing: 2
  • .github/CODERABBIT.md
  • CONTRIBUTING.md

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

Comment thread .github/CODERABBIT.md Outdated

@rwgk rwgk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @jpascucci-nv, this looks great, I only have two small suggested changes for details.

Comment thread CONTRIBUTING.md Outdated
Comment thread .github/CODERABBIT.md Outdated
@jpascucci-nv
jpascucci-nv merged commit fd5f89d into NVIDIA:main Oct 26, 2026
27 checks passed
github-actions Bot pushed a commit that referenced this pull request Oct 27, 2026
Removed preview folders for the following PRs:
- PR #2925
- PR #3133
- PR #3189
- PR #3208
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD CI/CD infrastructure cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P1 Medium priority - Should do PR review get-together Mark PRs you'd like the team to review at the weekly PR review get-together.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enable CodeRabbit auto-review on cuda-python (port CCCL's .coderabbit.yaml)

2 participants