You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -124,6 +124,20 @@ pnpm install
124
124
- Provide screenshots/videos for UI changes.
125
125
- Indicate if documentation updates are necessary.
126
126
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
+
127
141
### Pull Request Policy
128
142
129
143
- 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