Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add coderabbit configuration file #1852

Merged
merged 3 commits into from
May 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .coderabbit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
language: "en"
early_access: false
reviews:
request_changes_workflow: false
high_level_summary: true
poem: false
review_status: false
collapse_walkthrough: true
path_filters:
- "!api/"
path_instructions:
- path: "**/*.go"
instructions: "Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations."
- path: "tests/e2e/*"
instructions: |
"Assess the e2e test code assessing sufficient code coverage for the changes associated in the pull request"
- path: "tests/integration/*"
instructions: |
"Assess the e2e test code assessing sufficient code coverage for the changes associated in the pull request"
- path: "**/*_test.go"
instructions: |
"Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"
- path: "**/*.md"
instructions: |
"Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
- path: ".changelog/*"
instructions: |
"Assess the changes in the changelog for correctness and completeness, particularly flagging missing changes"
auto_review:
enabled: true
ignore_title_keywords:
- "WIP"
- "DO NOT MERGE"
drafts: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean it won't act on drafts before they are "ready for review"?
If yes, it might make sense to change this. If we had coderabbit comments already in the draft, we could apply its suggestions before publishing it for review.

Copy link
Contributor Author

@p-offtermatt p-offtermatt May 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's right. I think it's sufficient to get automatic comments when you put it out of draft; my fear is that it spams draft PRs with dozens of comments that you are aware of.
afaict you can get it to review outside of the auto-review guidelines by commenting @CodeRabbit review
(see the tips that are collapsed at the bottom of its review)

base_branches:
- "main"
- "feat/*"
- "release/*"
chat:
auto_reply: true
Loading