diff --git a/.coderabbit.yaml b/.coderabbit.yaml index 74b51b881dd3..318fdea0b00a 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -1,6 +1,26 @@ language: "en-US" reviews: + poem: false + suggested_reviewers: false + suggested_labels: false + sequence_diagrams: false high_level_summary: true + high_level_summary_placeholder: "@coderabbitai summary" + profile: chill + auto_review: + enabled: true + auto_incremental_review: true + ignore_usernames: [dependabot, asyncapi-bot] + review_status: true + commit_status: true + changed_files_summary: true + assess_linked_issues: true + related_issues: true + related_prs: true + pre_merge_checks: + title: + mode: error + requirements: "Use a concise title that follows our Conventional Commits guidelines and clearly summarizes the change in imperative mood (for example: 'add new helper for listing operations')." tools: markdownlint: enabled: true @@ -27,9 +47,20 @@ reviews: enabled: true knowledge_base: opt_out: false + web_search: + enabled: true + # Code Guidelines - automatically detects team standards + code_guidelines: + enabled: true + filePatterns: + # Add custom patterns here if you have other guideline files: + - ".github/pr-review-checklist.md" + - "CONTRIBUTING.md" learnings: scope: "local" issues: scope: "local" pull_requests: scope: "local" + mcp: + usage: auto diff --git a/.github/pr-review-checklist.md b/.github/pr-review-checklist.md new file mode 100644 index 000000000000..cb3b0e2cab12 --- /dev/null +++ b/.github/pr-review-checklist.md @@ -0,0 +1,21 @@ +### What reviewer looks at during PR review +The following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge. + +1. **PR Title**: Use a concise title that follows our [Conventional Commits](https://github.com/asyncapi/website/blob/master/CONTRIBUTING.md#conventional-commits) guidelines and clearly summarizes the change using [imperative mood](https://cbea.ms/git-commit/#imperative) (it means `spoken or written as if giving a command or instruction`, like "add new helper for listing operations") + +1. **PR Description**: Clearly explain the issue being solved, summarize the changes made, and mention the related issue. + > **Note** - Ensure the PR Description includes `Resolves #` or `Fixes #` this will automatically close the linked issue when the PR is merged and helps automate the maintainers workflow. + +1. **Test The Changes:** As a mandatory step, kindly attach the testing evidence from the temporary deployment link _(generated by netlify)_ after PR is opened. Even if your code is just a refactoring and does not add any new features, you should still provide testing evidence for the parts of the code you modified to ensure there are no regressions. + +1. **Comments and JSDoc**: Write clear and consistent JSDoc comments for functions, including parameter types, return values, and error conditions, so others can easily understand and use the code. + +1. **DRY Code**: Ensure the code follows the **Don't Repeat Yourself** principle. Look out for duplicate logic that can be reused. + +1. **Test Coverage**: Ensure the new code is well-tested with meaningful test cases that pass consistently and cover all relevant edge cases. + +1. **Commit History**: Contributors should avoid force-pushing as much as possible. It makes it harder to track incremental changes and review the latest updates. + +1. **Reduce Scope When Needed**: If an issue or PR feels too large or complex, consider splitting it and creating follow-up issues. Smaller, focused PRs are easier to review and merge. + +1. **Bot Comments:** As reviewers, check that contributors have appropriately addressed comments or suggestions made by automated bots. If there are bot comments the reviewer disagrees with, react to them or mark them as resolved, so the review history remains clear and accurate. \ No newline at end of file