Skip to main content
Research Preview Qodo uses your REVIEW.md file to apply repository-specific review guidelines during automated code review. It acts as a repository-level instruction file that influences what the review agents flag, how findings are prioritized, and what feedback is returned on every pull request.

What is REVIEW.md?

REVIEW.md is a file committed at the root of a repository (one per repository) that lets teams define project-specific review guidelines for Qodo’s automated code review. It shapes what the review agent flags, how it prioritizes findings, and what findings show up on every pull request. It refines the review process rather than replacing it. Use REVIEW.md to define repository-specific review guidance that Qodo’s review agents follow during every code review. This guidance refines review output and adjusts review emphasis without affecting coding assistants. Unlike general project documentation, REVIEW.md is only used by the code review agents.

Why use REVIEW.md?

By default, automated reviews are designed to work across a wide range of codebases. However, every codebase is different. REVIEW.md helps teams:
  • Align reviews with internal engineering standards
  • Avoid irrelevant or low-value comments
  • Increase the signal-to-noise ratio in pull request feedback
  • Encode architectural or business rules directly into review behavior
  • Ensure consistent enforcement across all repositories and reviewers
In practice, it turns code review from a generic linting-style system into a team-aware reviewer.

Enable REVIEW.md enforcement

To enable REVIEW.md enforcement for a repository:
  1. Log in to the Qodo portal.
  2. Navigate to Configurations > Code review.
  3. Enable the REVIEW.md instructions toggle.
Once enabled, Qodo will use the repository’s REVIEW.md file to guide code review findings.

How it works

When a review is triggered:
  1. Qodo scans the diff and surrounding code context.
  2. The review engine loads REVIEW.md from the repository root.
  3. All review agents, including issue detection, compliance, skills, specification, and persona analysis, use the repository’s REVIEW.md instructions when generating findings.
  4. Agents analyze the pull request according to those rules.
  5. Findings are returned as inline comments and grouped summaries.
If REVIEW.md is updated, the next pull request review automatically reflects the new rules.

View REVIEW.md findings

When REVIEW.md enforcement is enabled, any violations of rules defined in REVIEW.md are surfaced as findings in pull requests. You can view these findings:
  • As inline comments on the relevant code changes
  • In the findings panel alongside other code review findings
REVIEW.md findings are evaluated together with Qodo’s standard review checks, helping ensure pull requests comply with your repository-specific review requirements.

Basic structure of REVIEW.md

REVIEW.md is written in plain Markdown and has no required schema. You can organize it using standard Markdown headings and lists.

Example

Customization areas

Best practices

Keep REVIEW.md:
  • Concise: Focus on code behavior changes.
  • Specific: Describe what should be flagged.
  • Repository-specific: Avoid guidance already enforced by linters or formatting tools.
  • Stable: Frequent changes can lead to inconsistent review behavior.
  • Add separately: Add REVIEW.md in its own pull request rather than adding it to an existing pull request. REVIEW.md instructions apply to reviews triggered after the file is added. If you add REVIEW.md to an already open pull request, Qodo reviews only the current diff and does not re-review the entire pull request using the new instructions.