Repository navigation
[no-ci] Update CONTRIBUTING.md to include instructions about coderabbit - #3189
Conversation
closes NVIDIA#2137 Added the text from CCCL's coderabbit.rst to our CONTRIBUTING.md
|
Note Reviews pausedIt 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
Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review.
|
| 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:
Change: Other
Merge Risk: 
Minimal · up to 2fd84
-
The documentation-only change has no established merge-blocking risk.
Comment @coderabbitai help to get the list of available commands.
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
- Source mode: Auto
- Repository: NVIDIA/cuda-python
- Branch: main
- File: .coderabbit.yaml
- Commit: c968fcc
- Layers: Repository YAML
- Review profile: CHILL
- Plan: Enterprise
- Run ID:
2f8e1792-5106-4064-8309-4bd84a3d3c53
📒 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.
|
rwgk
left a comment
There was a problem hiding this comment.
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.
|
I added |
|
@rwgk That's where Rob told me to put it. I'll update the doc for the P2 issue, though. |
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. |
|
@rwgk Updated as we discussed in the meeting. |
There was a problem hiding this comment.
Actionable comments posted: 1

Review info
-
Run configuration-
- Source mode: Auto
- Repository: NVIDIA/cuda-python
- Branch: main
- File: .coderabbit.yaml
- Commit: c968fcc
- Layers: Repository YAML
- Review profile: CHILL
- Plan: Enterprise
- Run ID:
0ea55117-4f95-46e4-a625-4489443d98f9
Files selected for processing: 2-
.github/CODERABBIT.mdCONTRIBUTING.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.
-
rwgk
left a comment
There was a problem hiding this comment.
Thanks @jpascucci-nv, this looks great, I only have two small suggested changes for details.
[no-ci]
Description
closes #2137
Added the text from CCCL's coderabbit.rst to our CONTRIBUTING.md, per #2137 's rollout step 4.
Checklist