|
| 1 | +# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json |
| 2 | + |
| 3 | +# This file configures CodeRabbit with the various options described in https://docs.coderabbit.ai/configure-coderabbit. |
| 4 | +# CodeRabbit also has a set of commands here: https://docs.coderabbit.ai/guides/commands/ |
| 5 | + |
| 6 | +language: "en-US" |
| 7 | +early_access: false |
| 8 | +tone_instructions: "Be terse and to the point in all statements and commentary." |
| 9 | +reviews: |
| 10 | + # chill is less verbose, assertive is more verbose with more nitpick feedback |
| 11 | + profile: chill |
| 12 | + high_level_summary: false |
| 13 | + high_level_summary_placeholder: "@coderabbitai summary" |
| 14 | + sequence_diagrams: false |
| 15 | + auto_apply_labels: false |
| 16 | + suggested_reviewers: false |
| 17 | + changed_files_summary: false |
| 18 | + suggested_labels: false |
| 19 | + abort_on_close: true |
| 20 | + poem: false |
| 21 | + path_instructions: |
| 22 | + - path: '**/*.md' |
| 23 | + instructions: Remember that documentation must be updated with the latest information. |
| 24 | + - path: '**/*.rst' |
| 25 | + instructions: Remember that documentation must be updated with the latest information. |
| 26 | + - path: '**/*.py' |
| 27 | + instructions: >- |
| 28 | + Review the Python code for quality and correctness. Ensure variable names adhere to PEP8 style guides, are |
| 29 | + sensible and informative in regards to their function, though permitting simple names for loop and comprehension |
| 30 | + variables. Ensure routine names are meaningful in regards to their function and use verbs, adjectives, and |
| 31 | + nouns in a semantically appropriate way. Docstrings should be present for all definition which describe each |
| 32 | + variable, return value, and raised exception in the appropriate section of the Google-style of docstrings. |
| 33 | + Examine code for logical error or inconsistencies, and suggest what may be changed to addressed these. Suggest |
| 34 | + any enhancements for code improving efficiency, maintainability, comprehensibility, and correctness. Ensure new |
| 35 | + or modified definitions will be covered by existing or new unit tests. |
| 36 | +
|
| 37 | + auto_review: |
| 38 | + # Automatic Review | Automatic code review |
| 39 | + enabled: true |
| 40 | + # Review draft PRs/MRs. |
| 41 | + drafts: false |
| 42 | + # ignore PRs with these in the title, these sorts of PRs should be drafts anyway |
| 43 | + ignore_title_keywords: |
| 44 | + - "WIP" |
| 45 | + - "DO NOT MERGE" |
| 46 | + |
| 47 | +# opt out for now until it's clear this isn't too much info and is useful |
| 48 | +knowledge_base: |
| 49 | + opt_out: true |
| 50 | + |
| 51 | +# chat is allowed |
| 52 | +chat: |
| 53 | + auto_reply: true |
0 commit comments