|
| 1 | +# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
| 2 | +# SPDX-License-Identifier: Apache-2.0 |
| 3 | +# |
| 4 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +# you may not use this file except in compliance with the License. |
| 6 | +# You may obtain a copy of the License at |
| 7 | +# |
| 8 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +# |
| 10 | +# Unless required by applicable law or agreed to in writing, software |
| 11 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +# See the License for the specific language governing permissions and |
| 14 | +# limitations under the License. |
| 15 | + |
| 16 | +# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json |
| 17 | +# https://docs.coderabbit.ai/getting-started/configure-coderabbit/ |
| 18 | +# Validator https://docs.coderabbit.ai/configuration/yaml-validator#yaml-validator |
| 19 | +# In PR, comment "@coderabbitai configuration" to get the full config including defaults |
| 20 | +# Set the language for reviews by using the corresponding ISO language code. |
| 21 | +# Default: "en-US" |
| 22 | +language: "en-US" |
| 23 | +# Settings related to reviews. |
| 24 | +# Default: {} |
| 25 | +reviews: |
| 26 | + # Set the profile for reviews. Assertive profile yields more feedback, that may be considered nitpicky. |
| 27 | + # Options: chill, assertive |
| 28 | + # Default: "chill" |
| 29 | + profile: chill |
| 30 | + # Add this keyword in the PR/MR title to auto-generate the title. |
| 31 | + # Default: "@coderabbitai" |
| 32 | + auto_title_placeholder: '@coderabbitai title' |
| 33 | + # Auto Title Instructions - Custom instructions for auto-generating the PR/MR title. |
| 34 | + # Default: "" |
| 35 | + auto_title_instructions: 'Format: "[{modules}] {type}: {description}". Modules: model, recipe, training, data, ckpt, peft, perf, ci, doc, test, build, misc. Use comma to separate multiple modules. Type must be one of: feat, fix, refactor, chore, test. Title should be concise (<= 80 chars). Example: "[model] feat: Add Qwen3 model bridge" or "[recipe, doc] feat: Add Llama 3.1 70B recipe".' |
| 36 | + # Set the commit status to 'pending' when the review is in progress and 'success' when it is complete. |
| 37 | + # Default: true |
| 38 | + commit_status: false |
| 39 | + # Generate walkthrough in a markdown collapsible section. |
| 40 | + # Default: false |
| 41 | + collapse_walkthrough: true |
| 42 | + # Generate an assessment of how well the changes address the linked issues in the walkthrough. |
| 43 | + # Default: true |
| 44 | + assess_linked_issues: true |
| 45 | + # Include possibly related issues in the walkthrough. |
| 46 | + # Default: true |
| 47 | + related_issues: true |
| 48 | + # Related PRs - Include possibly related pull requests in the walkthrough. |
| 49 | + # Default: true |
| 50 | + related_prs: true |
| 51 | + # Suggest labels based on the changes in the pull request in the walkthrough. |
| 52 | + # Default: true |
| 53 | + suggested_labels: true |
| 54 | + # Suggest reviewers based on the changes in the pull request in the walkthrough. |
| 55 | + # Default: true |
| 56 | + suggested_reviewers: true |
| 57 | + # Generate a poem in the walkthrough comment. |
| 58 | + # Default: true |
| 59 | + poem: false |
| 60 | + # Post review details on each review. Additionally, post a review status when a review is skipped in certain cases. |
| 61 | + # Default: true |
| 62 | + review_status: false |
| 63 | + # Configuration for pre merge checks |
| 64 | + # Default: {} |
| 65 | + pre_merge_checks: |
| 66 | + # 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. |
| 67 | + # Default: [] |
| 68 | + custom_checks: |
| 69 | + - name: "Test Results for Major Changes" |
| 70 | + mode: "warning" # or "error" to block merges |
| 71 | + instructions: | |
| 72 | + 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. |
| 73 | + If a change could affect numerics or convergence, the PR description should include information demonstrating that there is no regression. |
| 74 | + 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. |
| 75 | + Pass if test results are documented or if the changes are minor. |
| 76 | + auto_review: |
| 77 | + # Configuration for auto review |
| 78 | + # Default: {} |
| 79 | + # Automatic Incremental Review - Automatic incremental code review on each push |
| 80 | + # Default: true |
| 81 | + auto_incremental_review: false |
| 82 | + # Review draft PRs/MRs. |
| 83 | + # Default: false |
| 84 | + drafts: false |
| 85 | + # Base branches (other than the default branch) to review. Accepts regex patterns. Use '.*' to match all branches. |
| 86 | + # Default: [] |
| 87 | + base_branches: ["main", "r[0-9].*"] |
| 88 | +# Configuration for knowledge base |
| 89 | +# Default: {} |
| 90 | +knowledge_base: |
| 91 | + code_guidelines: |
| 92 | + # 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. |
| 93 | + # Default: {} |
| 94 | + enabled: true |
| 95 | + # Enabled - Enable CodeRabbit to enforce your organization's coding standards during reviews. |
| 96 | + # Default: true |
| 97 | + filePatterns: |
| 98 | + # 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. |
| 99 | + # Default: [] |
| 100 | + - "**/skills/code-style/SKILL.md" |
| 101 | + - "**/.cursor/rules/*" |
| 102 | + - "**/CONTRIBUTING.md" |
0 commit comments