-
-
Notifications
You must be signed in to change notification settings - Fork 651
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
.coderabbit.yml
config and update pull request template (#16665)
Summary of the issue: CodeRabbit is a tool NV Access has been trialling for code reviews in NVDA. AI code reviews create helpful summaries of PRs, and pick up issues other reviews may miss, or pick up issues before another reviewer gets to it, saving time. Now that we are somewhat happy with the current config, we should commit it to the repository rather than rely on the GUI. This means contributors can more easily improve the auto review process such as improving the path prompts and adding learnings. Description of user facing changes AI code reviews will now happen automatically. Description of development approach Followed steps in docs.coderabbit.ai/guides/configure-coderabbit
- Loading branch information
Showing
4 changed files
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json | ||
# https://docs.coderabbit.ai/guides/configure-coderabbit/ | ||
|
||
language: "en-US" | ||
early_access: true | ||
reviews: | ||
profile: "chill" | ||
high_level_summary: true | ||
request_changes_workflow: false | ||
review_status: false | ||
collapse_walkthrough: false | ||
poem: false | ||
auto_review: | ||
enabled: true | ||
auto_incremental_review: false | ||
drafts: false | ||
base_branches: | ||
- master | ||
- beta | ||
- rc | ||
path_instructions: | ||
- path: "**/*" | ||
instructions: " | ||
Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. | ||
Avoid commenting on minor issues such as linting, formatting and style issues. | ||
This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. | ||
Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? | ||
Explain what makes them suspicious. | ||
" | ||
- path: "**/*.py" | ||
instructions: " | ||
_, pgettext, ngettext, and ngettext are defined globally, errors for this being undefined can be ignored. | ||
" | ||
- path: "**/*.md" | ||
instructions: " | ||
Focus on grammar, spelling, and punctuation. | ||
Also consider readability and clarity of contents. | ||
Ensure that changes follow the style of one sentence per line, suggest changes if this is not met. | ||
" | ||
tools: | ||
github-checks: | ||
enabled: true | ||
ruff: | ||
# Should become true if we switch linters, | ||
# right now linting is done by a flake8 check (#14817). | ||
enabled: false | ||
markdownlint: | ||
# We use custom markdown syntax such as {#Anchor} for anchors. | ||
# This is not supported by markdownlint. | ||
# In future we plan to introduce markdownlint directly with custom rules. (#16453) | ||
enabled: false | ||
chat: | ||
auto_reply: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters