Skip to content

Commit 2691bfa

Browse files
committed
Update CONTRIBUTING.md to include instructions about coderabbit
closes #2137 Added the text from CCCL's coderabbit.rst to our CONTRIBUTING.md
1 parent c968fcc commit 2691bfa

1 file changed

Lines changed: 67 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ Thank you for your interest in contributing to CUDA Python! Based on the type of
2828
- [Enabling git symlinks](#enabling-git-symlinks)
2929
- [Type stubs for cuda.core](#type-stubs-for-cudacore)
3030
- [Pre-commit](#pre-commit)
31+
- [CodeRabbit](#coderabbit)
32+
- [Configuration](#configuration)
33+
- [Pull Request Reviews](#pull-request-reviews)
34+
- [Review Guidance](#review-guidance)
3135
- [Pixi lockfiles](#pixi-lockfiles)
3236
- [Signing Your Work](#signing-your-work)
3337
- [Code signing](#code-signing)
@@ -235,6 +239,69 @@ between commits, leaving stale headers or out-of-date stubs in the history.
235239
If the hook isn't installed, `pre-commit run` will print a visible warning
236240
reminding you to run `pre-commit install`.
237241

242+
## CodeRabbit
243+
244+
This page explains how to configure and use CodeRabbit for CUDA Python pull
245+
request review. For the complete product documentation, see the
246+
[CodeRabbit documentation](https://docs.coderabbit.ai/).
247+
248+
### Configuration
249+
250+
CUDA Python configures CodeRabbit through `.coderabbit.yaml` in the repository
251+
root. The configuration in the pull request branch is used for that review.
252+
253+
When setting up or updating CodeRabbit:
254+
255+
1. Keep repository-specific settings in `.coderabbit.yaml`.
256+
2. Use `@coderabbitai configuration` on a pull request to inspect the resolved
257+
configuration. This is useful when checking whether CodeRabbit is using the
258+
expected repository settings for that pull request.
259+
3. Use `@coderabbitai generate configuration` to export the resolved
260+
configuration if a new baseline is needed. This is useful when moving
261+
settings into a reviewable repository configuration file.
262+
4. Keep configuration changes small and reviewable.
263+
5. Use `reviews.path_instructions` for path-specific review guidance.
264+
6. Use `knowledge_base.code_guidelines.filePatterns` for CUDA Python guidance
265+
files that CodeRabbit should read as review context.
266+
267+
The CUDA Python configuration should keep comments focused on correctness, API
268+
stability, performance, security, and other high-impact issues. Avoid enabling
269+
features that add noisy generated comments or code by default.
270+
271+
### Pull Request Reviews
272+
273+
Automatic reviews may be disabled or restricted by the repository
274+
configuration. Maintainers can always request review explicitly from a pull
275+
request comment:
276+
277+
```text
278+
@coderabbitai review
279+
```
280+
281+
Use a full review when the pull request should be reviewed again from scratch:
282+
283+
```text
284+
@coderabbitai full review
285+
```
286+
287+
Other useful commands:
288+
289+
- `@coderabbitai help` shows the current command reference.
290+
- `@coderabbitai configuration` shows the active configuration.
291+
- `@coderabbitai summary` can be placed in the pull request description as a
292+
placeholder for the generated summary.
293+
- `@coderabbitai pause` and `@coderabbitai resume` pause or resume automatic
294+
review behavior. This is useful when a pull request is still being updated
295+
frequently and should not be reviewed again until it is ready.
296+
- `@coderabbitai ignore` can be placed in the pull request description to
297+
disable automatic reviews.
298+
299+
### Review Guidance
300+
301+
Treat CodeRabbit feedback as review assistance, not as a merge requirement by
302+
itself. Maintainers remain responsible for deciding whether comments are
303+
actionable and whether a pull request has adequate tests and CI coverage.
304+
238305
## Pixi lockfiles
239306

240307
The repository checks in a `pixi.lock` next to each `pixi.toml`. Those lockfiles

0 commit comments

Comments
 (0)