-
Notifications
You must be signed in to change notification settings - Fork 194
ci: Add CodeRabbit configuration file #1063
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| # SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json | ||
| # https://docs.coderabbit.ai/getting-started/configure-coderabbit/ | ||
| # Validator https://docs.coderabbit.ai/configuration/yaml-validator#yaml-validator | ||
| # In PR, comment "@coderabbitai configuration" to get the full config including defaults | ||
| # Set the language for reviews by using the corresponding ISO language code. | ||
| # Default: "en-US" | ||
| language: "en-US" | ||
| # Settings related to reviews. | ||
| # Default: {} | ||
| reviews: | ||
| # Set the profile for reviews. Assertive profile yields more feedback, that may be considered nitpicky. | ||
| # Options: chill, assertive | ||
| # Default: "chill" | ||
| profile: chill | ||
| # Add this keyword in the PR/MR title to auto-generate the title. | ||
| # Default: "@coderabbitai" | ||
| auto_title_placeholder: '@coderabbitai title' | ||
| # Auto Title Instructions - Custom instructions for auto-generating the PR/MR title. | ||
| # Default: "" | ||
| auto_title_instructions: 'Format: "<category>: <title>". Category must be one of: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert, cp. The category must be followed by a colon. Title should be concise (<= 80 chars). Example: "feat: Add logit_bias support".' # current: '' | ||
| # Set the commit status to 'pending' when the review is in progress and 'success' when it is complete. | ||
| # Default: true | ||
| commit_status: false | ||
| # Generate walkthrough in a markdown collapsible section. | ||
| # Default: false | ||
| collapse_walkthrough: true | ||
| # Generate an assessment of how well the changes address the linked issues in the walkthrough. | ||
| # Default: true | ||
| assess_linked_issues: true | ||
| # Include possibly related issues in the walkthrough. | ||
| # Default: true | ||
| related_issues: true | ||
| # Related PRs - Include possibly related pull requests in the walkthrough. | ||
| # Default: true | ||
| related_prs: true | ||
| # Suggest labels based on the changes in the pull request in the walkthrough. | ||
| # Default: true | ||
| suggested_labels: true | ||
| # Suggest reviewers based on the changes in the pull request in the walkthrough. | ||
| # Default: true | ||
| suggested_reviewers: true | ||
| # Generate a poem in the walkthrough comment. | ||
| # Default: true | ||
| poem: false # current: true | ||
| # Post review details on each review. Additionally, post a review status when a review is skipped in certain cases. | ||
| # Default: true | ||
| review_status: false # current: true | ||
| # Configuration for pre merge checks | ||
| # Default: {} | ||
| pre_merge_checks: | ||
| # Custom Pre-merge Checks - Add unique checks to enforce your team's standards before merging a pull request. Each check must have a unique name (up to 50 characters) and clear instructions (up to 10000 characters). Use these to automatically verify coding, security, documentation, or business rules and maintain code quality. | ||
| # Default: [] | ||
| custom_checks: | ||
| - name: "Test Results for Major Changes" | ||
| mode: "warning" # or "error" to block merges | ||
| instructions: | | ||
| If this PR contains major changes (such as new features, breaking changes, or significant refactoring), verify that the PR description includes test results or testing information. | ||
| If a change could affect numerics or convergence, the PR description should include information demonstrating that there is no regression. | ||
| If a change could affect performance, the PR description should include before-and-after performance numbers, as well as the configuration and context in which they apply. | ||
| Pass if test results are documented or if the changes are minor. | ||
| auto_review: | ||
| # Configuration for auto review | ||
| # Default: {} | ||
| # Automatic Incremental Review - Automatic incremental code review on each push | ||
| # Default: true | ||
| auto_incremental_review: false # current: true | ||
| # Review draft PRs/MRs. | ||
| # Default: false | ||
| drafts: false | ||
| # Base branches (other than the default branch) to review. Accepts regex patterns. Use '.*' to match all branches. | ||
| # Default: [] | ||
| base_branches: ["main", "r[0-9].*", "chtruong/*"] # current: [] | ||
|
gwarmstrong marked this conversation as resolved.
Outdated
|
||
| # Configuration for knowledge base | ||
| # Default: {} | ||
| knowledge_base: | ||
| code_guidelines: | ||
| # CodeRabbit will analyse and learn from your organization's code guidelines, which you can mention in the file patterns section. These guidelines will then be used to conduct thorough code reviews. | ||
| # Default: {} | ||
| enabled: true | ||
| # Enabled - Enable CodeRabbit to enforce your organization's coding standards during reviews. | ||
| # Default: true | ||
| filePatterns: # current: [] | ||
| # File Patterns - Specify files for your coding guideline documents in this section. CodeRabbit will scan these files to understand your team's standards and apply them during code reviews. Multiple files supported. File names are case-sensitive. Common files like: (**/.cursorrules, .github/copilot-instructions.md, .github/instructions/*.instructions.md, **/CLAUDE.md, **/GEMINI.md, **/.cursor/rules/*, **/.windsurfrules, **/.clinerules/*, **/.rules/*, **/AGENT.md, **/AGENTS.md) are included by default. | ||
| # Default: [] | ||
| - "**/CODING_GUIDELINES.md" | ||
| - "**/.cursor/rules/*" | ||
|
gwarmstrong marked this conversation as resolved.
Outdated
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.