Skip to content

Commit 2790f1c

Browse files
committed
docs: add guidance for addressing automated review comments
- Added new section explaining how to handle automated review feedback - Clarifies that contributors must either fix issues or provide justification - Lists common automated reviewers (Roomote, security bots, CI/CD) - Addresses Issue #8533
1 parent 85b0e8a commit 2790f1c

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,20 @@ pnpm install
124124
- Provide screenshots/videos for UI changes.
125125
- Indicate if documentation updates are necessary.
126126

127+
### Addressing Automated Review Comments
128+
129+
Our repository uses automated review tools (including Roomote and other bots) to help maintain code quality. When you submit a PR, you may receive automated comments. Here's how to handle them:
130+
131+
- **Review all automated comments carefully** - They often catch important issues like code style violations, security concerns, or missing tests.
132+
- **For each automated comment, you must either:**
133+
- **Fix the issue:** Commit the necessary changes to address the feedback.
134+
- **Provide justification:** If you believe the suggestion is not applicable, comment on the PR explaining why the proposed change is not needed or appropriate for your specific case.
135+
- **Do not ignore automated comments** - Unaddressed automated feedback may delay or prevent PR approval.
136+
- **Common automated reviewers include:**
137+
- Roomote - Code quality and best practices
138+
- Security bots - Vulnerability scanning
139+
- CI/CD checks - Test failures and build issues
140+
127141
### Pull Request Policy
128142

129143
- Must reference an assigned GitHub Issue. To get assigned: comment "Claiming" on the issue and DM **Hannes Rudolph (`hrudolph`)** on [Discord](https://discord.gg/roocode). Assignment will be confirmed in the thread.

0 commit comments

Comments
 (0)