Skip to content

Commit d84fbd7

Browse files
jpascucci-nvjpascucci-nv
committed
Update contributing and move configuring section to its own file
1 parent 8ee9fce commit d84fbd7

2 files changed

Lines changed: 41 additions & 34 deletions

File tree

‎.github/CODERABBIT.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. -->
2+
<!-- SPDX-License-Identifier: Apache-2.0 -->
3+
4+
# CodeRabbit Configuration
5+
6+
This document explains how CodeRabbit is configured for CUDA Python. For review
7+
commands and guidance, see the
8+
[CodeRabbit section of the contributing guide](../CONTRIBUTING.md#coderabbit).
9+
For complete product documentation, see the
10+
[CodeRabbit documentation](https://docs.coderabbit.ai/).
11+
12+
CUDA Python configures CodeRabbit through [`.coderabbit.yaml`](../.coderabbit.yaml)
13+
in the repository root. The configuration in the pull request branch is used
14+
for that review. Pull requests from forks are an exception: they use the target
15+
branch's configuration, so changes to `.coderabbit.yaml` in a fork do not affect
16+
that review.
17+
18+
When setting up or updating CodeRabbit:
19+
20+
1. Keep repository-specific settings in `.coderabbit.yaml`.
21+
2. Use `@coderabbitai configuration` on a pull request to inspect the resolved
22+
configuration. This is useful when checking whether CodeRabbit is using the
23+
expected repository settings for that pull request.
24+
3. Use `@coderabbitai generate configuration` to export the resolved
25+
configuration if a new baseline is needed. This is useful when moving
26+
settings into a reviewable repository configuration file.
27+
4. Keep configuration changes small and reviewable.
28+
5. Use `reviews.path_instructions` for path-specific review guidance.
29+
6. Use `knowledge_base.code_guidelines.filePatterns` for CUDA Python guidance
30+
files that CodeRabbit should read as review context.
31+
32+
The CUDA Python configuration should keep comments focused on correctness, API
33+
stability, performance, security, and other high-impact issues. Avoid enabling
34+
features that add noisy generated comments or code by default.

‎CONTRIBUTING.md‎

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,8 @@ Thank you for your interest in contributing to CUDA Python! Based on the type of
2929
- [Type stubs for cuda.core](#type-stubs-for-cudacore)
3030
- [Pre-commit](#pre-commit)
3131
- [CodeRabbit](#coderabbit)
32-
- [Configuration](#configuration)
33-
- [Pull Request Reviews](#pull-request-reviews)
3432
- [Review Guidance](#review-guidance)
33+
- [Pull Request Reviews](#pull-request-reviews)
3534
- [Pixi lockfiles](#pixi-lockfiles)
3635
- [Signing Your Work](#signing-your-work)
3736
- [Code signing](#code-signing)
@@ -241,35 +240,15 @@ reminding you to run `pre-commit install`.
241240

242241
## CodeRabbit
243242

244-
This page explains how to configure and use CodeRabbit for CUDA Python pull
245-
request review. For the complete product documentation, see the
243+
This section explains how to use CodeRabbit for CUDA Python pull request review.
244+
For complete product documentation, see the
246245
[CodeRabbit documentation](https://docs.coderabbit.ai/).
247246

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-
Pull requests from forks are an exception: they use the target branch's
253-
configuration, so changes to `.coderabbit.yaml` in a fork do not affect that
254-
review.
255-
256-
When setting up or updating CodeRabbit:
257-
258-
1. Keep repository-specific settings in `.coderabbit.yaml`.
259-
2. Use `@coderabbitai configuration` on a pull request to inspect the resolved
260-
configuration. This is useful when checking whether CodeRabbit is using the
261-
expected repository settings for that pull request.
262-
3. Use `@coderabbitai generate configuration` to export the resolved
263-
configuration if a new baseline is needed. This is useful when moving
264-
settings into a reviewable repository configuration file.
265-
4. Keep configuration changes small and reviewable.
266-
5. Use `reviews.path_instructions` for path-specific review guidance.
267-
6. Use `knowledge_base.code_guidelines.filePatterns` for CUDA Python guidance
268-
files that CodeRabbit should read as review context.
247+
### Review Guidance
269248

270-
The CUDA Python configuration should keep comments focused on correctness, API
271-
stability, performance, security, and other high-impact issues. Avoid enabling
272-
features that add noisy generated comments or code by default.
249+
We treat CodeRabbit feedback as review assistance, not as a merge requirement by
250+
itself. Maintainers remain responsible for deciding whether comments are
251+
actionable and whether a pull request has adequate tests and CI coverage.
273252

274253
### Pull Request Reviews
275254

@@ -299,12 +278,6 @@ Other useful commands:
299278
- `@coderabbitai ignore` can be placed in the pull request description to
300279
disable automatic reviews.
301280

302-
### Review Guidance
303-
304-
Treat CodeRabbit feedback as review assistance, not as a merge requirement by
305-
itself. Maintainers remain responsible for deciding whether comments are
306-
actionable and whether a pull request has adequate tests and CI coverage.
307-
308281
## Pixi lockfiles
309282

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

0 commit comments

Comments
 (0)