Skip to content

docs: clarify handling of automated review comments in PR process #8534

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.

Sign up for GitHub

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

Closed
roomote wants to merge 1 commit into from
Closed

docs: clarify handling of automated review comments in PR process #8534

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,20 @@ pnpm install
- Provide screenshots/videos for UI changes.
- Indicate if documentation updates are necessary.

### Addressing Automated Review Comments
Copy link
Contributor Author

@roomote roomote bot Oct 6, 2025

Choose a reason for hiding this comment

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

[P2] Localization gap: this repo maintains translated copies of CONTRIBUTING.md under locales/. When adding a new section, please either (a) include matching stubs/updates in the localized files, or (b) open a follow-up issue and tag this PR with "needs-translation" so we track parity.


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:

- **Review all automated comments carefully** - They often catch important issues like code style violations, security concerns, or missing tests.
- **For each automated comment, you must either:**
- **Fix the issue:** Commit the necessary changes to address the feedback.
- **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.
- **Do not ignore automated comments** - Unaddressed automated feedback may delay or prevent PR approval.
- **Common automated reviewers include:**
- Roomote - Code quality and best practices
- Security bots - Vulnerability scanning
- CI/CD checks - Test failures and build issues

### Pull Request Policy

- 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.
Expand Down