Repository navigation
Expand file tree
/
Copy path.coderabbit.yaml
More file actions
98 lines (98 loc) · 6.25 KB
/
Copy path.coderabbit.yaml
File metadata and controls
98 lines (98 loc) · 6.25 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# 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
path_instructions:
- path: "fern/docs.yml"
instructions: |
Redirect destinations for documentation pages must use the rendered Fern route from docs/index.yml, not the source file path.
In docs/index.yml, the rendered URL comes from the section/page `slug` hierarchy; the `path` field only points to the source MDX file.
For example, the source path docs/configure-rails/colang/colang-2/language-reference/introduction.mdx renders under /configure-guardrails/colang/colang-2/language-reference/introduction because the top-level Configure Guardrails section has slug `configure-guardrails`.
Do not suggest replacing valid rendered routes such as /configure-guardrails/... with source-path-derived routes such as /configure-rails/....
Before flagging a redirect destination as wrong, verify the route by tracing the relevant entries in docs/index.yml.
- path: "docs/**/*.mdx"
instructions: |
Internal absolute documentation links in Fern MDX pages must use the rendered Fern route, not the source file path.
Derive routes from the slug hierarchy in docs/index.yml. For example:
- docs/configure-rails/index.mdx renders at /configure-guardrails/configure-rails, not /configure-rails.
- docs/configure-rails/colang/index.mdx renders at /configure-guardrails/colang, not /configure-rails/colang.
- docs/run-rails/index.mdx renders at /run-guardrailed-inference/run-rails, not /run-rails.
- docs/getting-started/installation-guide.mdx renders at /get-started/installation-guide, not /getting-started/installation-guide.
Before flagging or suggesting fixes for internal docs links, verify them with docs/index.yml.
Do not suggest changing valid Fern routes back to source-path-style links.
- path: "docs/**/*.ipynb"
instructions: |
Markdown links in documentation notebooks should match the rendered Fern routes when they point to docs pages.
Use docs/index.yml slug hierarchy as the source of truth for internal documentation routes.
Do not suggest changing valid Fern routes such as /configure-guardrails/... to source file paths such as /configure-rails/....
# 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
# Only auto-review PRs labeled `status: triaged` (auto-applied for maintainers
# / NVIDIA-NeMo org members; a maintainer adds it after triage for external
# contributors). Gates review noise on agent/external PRs.
labels:
- "status: triaged"
# Base branches (other than the default branch) to review. Accepts regex patterns. Use '.*' to match all branches.