Skip to content

Commit e3a8695

Browse files
committed
chore: add coderabbit config structure and files
1 parent dfbb68a commit e3a8695

8 files changed

+306
-0
lines changed

configs/github/reviewpad.yaml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
language: "en"
2+
early_access: false
3+
reviews:
4+
request_changes_workflow: true
5+
high_level_summary: true
6+
poem: false
7+
review_status: true
8+
collapse_walkthrough: false
9+
path_filters:
10+
- "!**/.xml"
11+
path_instructions:
12+
- path: "**/*.cs"
13+
instructions: "Focus on major issues impacting readability and maintainability. Avoid minor nitpicks."
14+
- path: "tests/**/*.cs"
15+
instructions: "Review NUnit tests for structure and coverage. Skip minor stylistic concerns."
16+
- path: "**/*.py"
17+
instructions: "Check for major PEP 8 violations and Python best practices. Ignore trivial formatting issues."
18+
- path: "tests/**/*.py"
19+
instructions: "Ensure PyTest tests are clear and comprehensive. Don't focus on minor details."
20+
- path: "**/*.js"
21+
instructions: "Review for significant deviations from Google JavaScript style guide. Minor style issues are not a priority."
22+
auto_review:
23+
enabled: true
24+
ignore_title_keywords:
25+
- "WIP"
26+
- "DO NOT MERGE"
27+
drafts: false
28+
base_branches:
29+
- "develop"
30+
- "feat/*"
31+
chat:
32+
auto_reply: true
+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# https://docs.coderabbit.ai/guides/configure-coderabbit
2+
language: "en-US"
3+
early_access: false
4+
chat: { auto_reply: true }
5+
tone_instructions: >-
6+
Maintain a formal tone, highlighting issues, and suggesting production-grade, elegant, and concise solutions.
7+
8+
reviews:
9+
profile: chill
10+
high_level_summary: true
11+
12+
# disables the cringe
13+
poem: false
14+
15+
collapse_walkthrough: true
16+
sequence_diagrams: true
17+
18+
path_filters:
19+
- "!**/*.pb.go"
20+
- "!**/*.pb.gw.go"
21+
- "!**/*_pb.d.ts"
22+
23+
path_instructions:
24+
- path: '**/*.go'
25+
instructions: >-
26+
Review the Go code, point out issues relative to principles of clean
27+
code, expressiveness, and performance.
28+
- path: '**/*.proto'
29+
instructions: >-
30+
Review the Protobuf definitions, point out issues relative to
31+
compatibility, and expressiveness.
32+
- path: '**/*.sh'
33+
instructions: >-
34+
Review the shell scripts, point out issues relative to security,
35+
performance, and maintainability.
36+
37+
auto_review:
38+
drafts: false
39+
# disables review for new commits
40+
auto_incremental_review: false
41+
base_branches:
42+
- develop
43+
44+
tools:
45+
languagetool:
46+
enabled: true
47+
level: default
+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
2+
language: "en"
3+
early_access: false
4+
reviews:
5+
request_changes_workflow: false
6+
high_level_summary: true
7+
poem: false
8+
review_status: true
9+
collapse_walkthrough: true
10+
path_filters:
11+
- "!api/**"
12+
- "!wardenjs/src/codegen/**"
13+
- "!tests/testdata/**"
14+
path_instructions:
15+
- path: "**/*.go"
16+
instructions: "Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations."
17+
- path: "tests/**/*"
18+
instructions: |
19+
"Assess the integration and e2e test code assessing sufficient code coverage for the changes associated in the pull request"
20+
- path: "**/*_test.go"
21+
instructions: |
22+
"Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"
23+
- path: "**/*.md"
24+
instructions: |
25+
"Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
26+
auto_review:
27+
enabled: true
28+
ignore_title_keywords:
29+
- "WIP"
30+
- "DO NOT MERGE"
31+
drafts: false
32+
base_branches:
33+
- "main"
34+
chat:
35+
auto_reply: true
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
language: "en"
2+
3+
early_access: false
4+
5+
reviews:
6+
request_changes_workflow: true
7+
high_level_summary: true
8+
poem: false
9+
review_status: true
10+
collapse_walkthrough: false
11+
path_filters:
12+
- "!**/.xml"
13+
path_instructions:
14+
- path: "**/*.css"
15+
instructions: |
16+
"Review the CSS code against the google css style guide and point out any mismatches. Ensure that:
17+
- The code adheres to best practices associated with CSS.
18+
- The code adheres to best practices recommended by lighthouse or similar tools for performance.
19+
- The code adheres to similar naming conventions for classes, ids."
20+
- path: "**/*.html"
21+
instructions: |
22+
"Review the HTML code against the google html style guide and point out any mismatches. Ensure that:
23+
- The code adheres to best practices recommended by lighthouse or similar tools for performance."
24+
- path: "**/*.js,**/*.ts"
25+
instructions: |
26+
"Review the JAVASCRIPT code against the google javascript style guide and point out any mismatches. Ensure that:
27+
- The code adheres to best practices associated with React.
28+
- The code adheres to best practices associated with React PWA.
29+
- The code adheres to best practices associated with SPA.
30+
- The code adheres to best practices recommended by lighthouse or similar tools for performance.
31+
- The code adheres to similar naming conventions for components, views, methods."
32+
auto_review:
33+
enabled: true
34+
ignore_title_keywords:
35+
- "WIP"
36+
- "DO NOT MERGE"
37+
drafts: false
38+
base_branches:
39+
- "master"
40+
- "dev"
41+
- "feat/*"
42+
- "feat-*"
43+
- "release-*"
44+
45+
chat:
46+
auto_reply: true
47+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
language: "en"
2+
3+
early_access: false
4+
5+
reviews:
6+
request_changes_workflow: true
7+
high_level_summary: true
8+
poem: false
9+
review_status: true
10+
collapse_walkthrough: false
11+
path_filters:
12+
- "!**/.xml"
13+
path_instructions:
14+
- path: "**/*.js"
15+
instructions: "Review the JavaScript code for conformity with the Google JavaScript style guide, highlighting any deviations."
16+
- path: "**/*.ts"
17+
instructions: |
18+
"Review the JavaScript code for conformity with the Google JavaScript style guide, highlighting any deviations. Ensure that:
19+
- The code adheres to best practices associated with nodejs.
20+
- The code adheres to best practices associated with nestjs framework.
21+
- The code adheres to best practices recommended for performance.
22+
- The code adheres to similar naming conventions for controllers, models, services, methods, variables."
23+
auto_review:
24+
enabled: true
25+
ignore_title_keywords:
26+
- "WIP"
27+
- "DO NOT MERGE"
28+
drafts: false
29+
base_branches:
30+
- "master"
31+
- "dev"
32+
- "feat/*"
33+
- "feat-*"
34+
- "release-*"
35+
- "Shiksha-2.0"
36+
37+
chat:
38+
auto_reply: true
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
language: en
3+
4+
early_access: true
5+
6+
reviews:
7+
request_changes_workflow: false
8+
9+
high_level_summary: true
10+
11+
poem: false
12+
13+
review_status: true
14+
15+
collapse_walkthrough: true
16+
17+
path_filters:
18+
- wg_utilities/**/*.py
19+
20+
path_instructions:
21+
- path: wg_utilities/**/*.py
22+
instructions: >-
23+
Review the Python code against the PEP 8 style guide. Highlight any deviations,
24+
including issues with variable names, function naming conventions, line length,
25+
and use of spaces vs. tabs. Ensure the use of docstrings for functions and
26+
classes.
27+
28+
Additionally, evaluate the Python code for functional efficiency and
29+
optimization. Identify areas where the implementation could be improved, such
30+
as suboptimal use of variables/memory, inefficient input/output operations, or
31+
any other aspects that could hinder performance. Assess the clarity and
32+
appropriateness of variable and function names in the context of their roles
33+
within the code. Examine for potential logical errors or parts of the code that
34+
might lead to unexpected behavior. Suggestions for enhancing the code's
35+
efficiency and maintainability are highly encouraged.
36+
37+
auto_review:
38+
enabled: true
39+
drafts: false
40+
41+
chat:
42+
auto_reply: true
+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
language: "en"
2+
early_access: false
3+
reviews:
4+
request_changes_workflow: false
5+
high_level_summary: true
6+
poem: true
7+
review_status: true
8+
collapse_walkthrough: false
9+
path_filters:
10+
- "!**/.xml"
11+
- "!**/__generated__/**"
12+
- "!**/generated/**"
13+
- "!**/*.json"
14+
- "!**/*.svg"
15+
- "!**/*.png"
16+
- "!**/*.jpg"
17+
- "!**/*.gif"
18+
- "!**/*.lock"
19+
path_instructions:
20+
- path: "**/*.{ts,tsx}"
21+
instructions:
22+
"Review the Typescript and React code for conformity with best practices in React, Recoil,
23+
Graphql, and Typescript. Highlight any deviations."
24+
auto_review:
25+
enabled: true
26+
ignore_title_keywords:
27+
- "WIP"
28+
- "DO NOT MERGE"
29+
- "DRAFT"
30+
drafts: false
31+
base_branches:
32+
- "develop"
33+
- "main"
34+
- "release/.*"
35+
- "feat/.*"
36+
chat:
37+
auto_reply: true
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
reviews:
2+
path_filters:
3+
- "!v1/pkg/**"
4+
- "!v2/pkg/**"
5+
- "!v1/typechain-types/**"
6+
- "!v2/types/**"
7+
- "!v1/docs/**"
8+
- "!v2/docs/**"
9+
- "!v1/data/**"
10+
- "!v2/data/**"
11+
path_instructions:
12+
- path: "contracts/**"
13+
instructions: >-
14+
Review the Solidity contracts for security vulnerabilities and best practices.
15+
- path: "test/**"
16+
instructions: >-
17+
Review the test files for proper coverage, edge cases, and best practices.
18+
- path: "scripts/**"
19+
instructions: >-
20+
Review the Hardhat scripts for best practices.
21+
- path: "tasks/**"
22+
instructions: >-
23+
Review the Hardhat tasks for best practices.
24+
auto_review:
25+
base_branches:
26+
- main
27+
poem: false
28+
collapse_walkthrough: true

0 commit comments

Comments
 (0)