From b1c7e17ad35dc7c4006ddaf893bf8ffae2eeb238 Mon Sep 17 00:00:00 2001 From: Eric Kerfoot Date: Fri, 18 Jul 2025 11:47:59 +0100 Subject: [PATCH 1/7] Adding .coderabbit.yaml file Signed-off-by: Eric Kerfoot --- .coderabbit.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .coderabbit.yaml diff --git a/.coderabbit.yaml b/.coderabbit.yaml new file mode 100644 index 0000000000..f90d9bfa93 --- /dev/null +++ b/.coderabbit.yaml @@ -0,0 +1,19 @@ +language: "en-US" +early_access: false +tone_instructions: "Be terse and to the point in all statements and commentary." +reviews: + profile: chill + high_level_summary: false + # This placeholder doesn't exist, so this effectively disables the summary in the description. + high_level_summary_placeholder: "@coderabbitai summary" + sequence_diagrams: false + auto_apply_labels: false + suggested_reviewers: false + changed_files_summary: false + suggested_labels: false + poem: false + path_instructions: + - path: '**/*.md' + instructions: Remember that markdown documentation must be updated with the latest information. +knowledge_base: + opt_out: true \ No newline at end of file From 2e8389309828aa8cd22f13681be0fbdddc056183 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 18 Jul 2025 10:49:19 +0000 Subject: [PATCH 2/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .coderabbit.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.coderabbit.yaml b/.coderabbit.yaml index f90d9bfa93..b05c31d94b 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -16,4 +16,4 @@ reviews: - path: '**/*.md' instructions: Remember that markdown documentation must be updated with the latest information. knowledge_base: - opt_out: true \ No newline at end of file + opt_out: true From 1be78e324117ef2f2167ba9b2f9feea6e05fd113 Mon Sep 17 00:00:00 2001 From: YunLiu <55491388+KumoLiu@users.noreply.github.com> Date: Fri, 18 Jul 2025 22:08:08 +0800 Subject: [PATCH 3/7] Apply suggestion from @mingxin-zheng Co-authored-by: Mingxin Zheng Signed-off-by: YunLiu <55491388+KumoLiu@users.noreply.github.com> --- .coderabbit.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.coderabbit.yaml b/.coderabbit.yaml index b05c31d94b..ea708ece81 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -15,5 +15,11 @@ reviews: path_instructions: - path: '**/*.md' instructions: Remember that markdown documentation must be updated with the latest information. + auto_review: + # Automatic Review | Automatic code review + enabled: true + # Review draft PRs/MRs. + drafts: false + knowledge_base: opt_out: true From 749681d9c773ccce3a0d565aa75c5bdb8961aa1a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 18 Jul 2025 14:08:32 +0000 Subject: [PATCH 4/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .coderabbit.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.coderabbit.yaml b/.coderabbit.yaml index ea708ece81..2028010bb6 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -20,6 +20,6 @@ reviews: enabled: true # Review draft PRs/MRs. drafts: false - + knowledge_base: opt_out: true From 63fcf17b56414ac0aae0e64830b9c43f4a869724 Mon Sep 17 00:00:00 2001 From: YunLiu <55491388+KumoLiu@users.noreply.github.com> Date: Fri, 18 Jul 2025 22:13:52 +0800 Subject: [PATCH 5/7] Update .coderabbit.yaml Signed-off-by: YunLiu <55491388+KumoLiu@users.noreply.github.com> --- .coderabbit.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 2028010bb6..11d5d0e2b1 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -4,7 +4,6 @@ tone_instructions: "Be terse and to the point in all statements and commentary." reviews: profile: chill high_level_summary: false - # This placeholder doesn't exist, so this effectively disables the summary in the description. high_level_summary_placeholder: "@coderabbitai summary" sequence_diagrams: false auto_apply_labels: false From 32d193c887d4db40e9be84aa1b4e96c0870e7915 Mon Sep 17 00:00:00 2001 From: Eric Kerfoot Date: Sat, 19 Jul 2025 12:34:23 +0100 Subject: [PATCH 6/7] Update to config file with added instructions and commentary Signed-off-by: Eric Kerfoot --- .coderabbit.yaml | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 11d5d0e2b1..104443310e 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -1,7 +1,13 @@ +# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json + +# This file configures CodeRabbit with the various options described in https://docs.coderabbit.ai/configure-coderabbit. +# CodeRabbit also has a set of commands here: https://docs.coderabbit.ai/guides/commands/ + language: "en-US" early_access: false tone_instructions: "Be terse and to the point in all statements and commentary." reviews: + # chill is less verbose, assertive is more verbose with more nitpick feedback profile: chill high_level_summary: false high_level_summary_placeholder: "@coderabbitai summary" @@ -10,15 +16,38 @@ reviews: suggested_reviewers: false changed_files_summary: false suggested_labels: false + abort_on_close: true poem: false path_instructions: - path: '**/*.md' - instructions: Remember that markdown documentation must be updated with the latest information. + instructions: Remember that documentation must be updated with the latest information. + - path: '**/*.rst' + instructions: Remember that documentation must be updated with the latest information. + - path: '**/*.py' + instructions: >- + Review the Python code for quality and correctness. Ensure variable names adhere to PEP8 style guides, are + sensible and informative in regards to their function, though permitting simple names for loop and comprehension + variables. Ensure routine names are meaningful in regards to their function and use verbs, adjectives, and + nouns in a semantically appropriate way. Docstrings should be present for all definition which describe each + variable, return value, and raised exception in the appropriate section of the Google-style of docstrings. + Examine code for logical error or inconsistencies, and suggest what may be changed to addressed these. Suggest + any enhancements for code improving efficiency, maintainability, comprehensibility, and correctness. Ensure new + or modified definitions will be covered by existing or new unit tests. + auto_review: # Automatic Review | Automatic code review enabled: true # Review draft PRs/MRs. drafts: false + # ignore PRs with these in the title, these sorts of PRs should be drafts anyway + ignore_title_keywords: + - "WIP" + - "DO NOT MERGE" +# opt out for now until it's clear this isn't too much info and is useful knowledge_base: opt_out: true + +# chat is allowed +chat: + auto_reply: true \ No newline at end of file From 84bd10fedd0a91353b14f5bcec68b7a414c8702a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 19 Jul 2025 11:34:50 +0000 Subject: [PATCH 7/7] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .coderabbit.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 104443310e..909f6947c9 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -7,7 +7,7 @@ language: "en-US" early_access: false tone_instructions: "Be terse and to the point in all statements and commentary." reviews: - # chill is less verbose, assertive is more verbose with more nitpick feedback + # chill is less verbose, assertive is more verbose with more nitpick feedback profile: chill high_level_summary: false high_level_summary_placeholder: "@coderabbitai summary" @@ -25,11 +25,11 @@ reviews: instructions: Remember that documentation must be updated with the latest information. - path: '**/*.py' instructions: >- - Review the Python code for quality and correctness. Ensure variable names adhere to PEP8 style guides, are + Review the Python code for quality and correctness. Ensure variable names adhere to PEP8 style guides, are sensible and informative in regards to their function, though permitting simple names for loop and comprehension - variables. Ensure routine names are meaningful in regards to their function and use verbs, adjectives, and + variables. Ensure routine names are meaningful in regards to their function and use verbs, adjectives, and nouns in a semantically appropriate way. Docstrings should be present for all definition which describe each - variable, return value, and raised exception in the appropriate section of the Google-style of docstrings. + variable, return value, and raised exception in the appropriate section of the Google-style of docstrings. Examine code for logical error or inconsistencies, and suggest what may be changed to addressed these. Suggest any enhancements for code improving efficiency, maintainability, comprehensibility, and correctness. Ensure new or modified definitions will be covered by existing or new unit tests. @@ -50,4 +50,4 @@ knowledge_base: # chat is allowed chat: - auto_reply: true \ No newline at end of file + auto_reply: true