Support for standard coding guideline files being used for reviews

[ParthGandhi]

We'll now read the default coding guideline files (cursorrules, etc) and use these to improve code review performance.

Users can also disable this feature from the UI.
Users can optionally add additional files from the UI (will share screenshots separately).

Internally these get split into path instructions and learnings, but we don't need to tell the user that.

List of files we support:

	"**/.cursorrules",
	".github/copilot-instructions.md",
	"**/CLAUDE.md",
	"**/.cursor/rules/*",
	"**/.windsurfrules",
	"**/.clinerules/*",
	"**/.rules",

[linear]

ENG-1698 Support for standard coding guideline files being used for reviews

[traycerai]

Plan

Observations

Docs already contain extensive instructions for path-based and AST-based reviews. New feature auto-detects well-known guideline files, can be toggled in UI, and optionally extended via YAML. We only need to update docs: add subsection inside existing review guide, mention YAML config & UI path, and log change in changelog. No code or sidebar updates are required.

Approach

1. Enhance docs/guides/review-instructions.md with a Standard Coding Guideline Files section right after the path-based instructions.
2. Document supported file globs, behaviour overview, UI navigation path (Configuration > Review > Settings > Coding Guidelines), YAML configuration example, and note about interaction with existing instructions. Include screenshot placeholder.
3. Amend docs/getting-started/configure-coderabbit.md with a short reference to the new YAML keys, linking back to the review guide.
4. Create a new top-of-file entry in docs/changelog.md describing the feature using the project’s established upbeat format.
5. No sidebar or structural changes are required because the new content lives inside an existing guide.

Reasoning

Explored current guides, configuration docs, changelog, and sidebar; analysed UI-path and YAML patterns to shape consistent documentation. Determined that inserting a subsection avoids navigation changes while keeping related content together.

Proposed File Changes

📄 docs/guides/review-instructions.md ^(MODIFY) 🔗

References

• 🔗 ui-coding-guidelines.png

Insert a new H2 section ## Standard Coding Guideline Files {#standard-coding-guidelines} immediately after the existing Path-based Instructions block.

Section outline:

1. Introductory paragraph explaining automatic discovery and why it helps.
2. Fenced code block listing supported patterns exactly as:

   **/.cursorrules
   .github/copilot-instructions.md
   **/CLAUDE.md
   **/.cursor/rules/*
   **/.windsurfrules
   **/.clinerules/*
   **/.rules
   

3. Bullet explanation of how CodeRabbit loads these files and that users need not manage parsing.
4. Sub-section UI Controls detailing navigation Configuration > Review > Settings > Coding Guidelines, describing the enable/disable toggle and "Add File" control; include a Markdown image placeholder: ![Coding Guidelines UI](../img/ui-coding-guidelines.png).
5. Sub-section YAML Configuration (optional) with sample block:

   reviews:
     standard_coding_guidelines:
       enabled: true  # set to false to disable
       additional_files:
         - "docs/team-guidelines.md"
         - "guides/rules/extra.clinerules"

   Note precedence (YAML overrides UI) and cumulative behaviour with existing path/AST instructions.
6. Tip call-out reminding that the feature complements current review instructions.
7. Placeholder note saying screenshots will be added once UI is finalized.

📄 docs/getting-started/configure-coderabbit.md ^(MODIFY) 🔗

Within the section that explains YAML configuration options, add a short paragraph and anchor link:

• Mention new reviews.standard_coding_guidelines block, its enabled boolean, and additional_files list.
• Point readers to Guides → Review Instructions → Standard Coding Guideline Files for full details.
  Place this just after the existing bullet list that introduces common reviews sub-keys.

📄 docs/changelog.md ^(MODIFY) 🔗

References

• 📄 docs/guides/review-instructions.md ^(MODIFY)

Add a new entry at top of file:

## {{CURRENT_DATE}}

### Standard Coding Guideline Files Support

We're excited to announce automatic support for standard coding guideline files!  
**Key capabilities:**
- Detects `.cursorrules`, `.github/copilot-instructions.md`, `CLAUDE.md`, `.cursor/rules/*`, `.windsurfrules`, `.clinerules/*`, and `.rules` out of the box.
- Uses these guidelines to sharpen AI-powered code reviews.
- Simple toggle to enable or disable the feature in the UI.
- Option to add extra custom guideline files.
- Works alongside existing path-based and AST-based instructions.

Read more in our [Review Instructions guide](./guides/review-instructions.md#standard-coding-guidelines).

Replace {{CURRENT_DATE}} with actual release date before merge.

Diagram

sequenceDiagram
    participant Dev as Developer pushes PR
    participant CR as CodeRabbit
    participant Repo as Repo Files
    Dev->>CR: Trigger review
    CR-->>Repo: Scan repository
    Repo-->>CR: Return standard guideline files
    CR->>CR: Parse & merge with path/AST instructions
    CR-->>Dev: Produce enhanced review

Loading

Import In IDE

🤖 Prompt for AI Agents

I have created the following plan after thorough exploration and analysis of the codebase. Follow the below plan verbatim. Trust the files and references. Do not re-verify what's written in the plan. Explore only when aboslutely necessary. First implement all the proposed file changes and then I'll review all the changes together at the end.

### Observations

Docs already contain extensive instructions for path-based and AST-based reviews. New feature auto-detects well-known guideline files, can be toggled in UI, and optionally extended via YAML. We only need to update docs: add subsection inside existing review guide, mention YAML config & UI path, and log change in changelog. No code or sidebar updates are required.

### Approach

1. Enhance `docs/guides/review-instructions.md` with a **Standard Coding Guideline Files** section right after the path-based instructions.  
2. Document supported file globs, behaviour overview, UI navigation path (`Configuration > Review > Settings > Coding Guidelines`), YAML configuration example, and note about interaction with existing instructions. Include screenshot placeholder.  
3. Amend `docs/getting-started/configure-coderabbit.md` with a short reference to the new YAML keys, linking back to the review guide.  
4. Create a new top-of-file entry in `docs/changelog.md` describing the feature using the project’s established upbeat format.  
5. No sidebar or structural changes are required because the new content lives inside an existing guide.

### Reasoning

Explored current guides, configuration docs, changelog, and sidebar; analysed UI-path and YAML patterns to shape consistent documentation. Determined that inserting a subsection avoids navigation changes while keeping related content together.

## Mermaid Diagram

sequenceDiagram
    participant Dev as Developer pushes PR
    participant CR as CodeRabbit
    participant Repo as Repo Files
    Dev->>CR: Trigger review
    CR-->>Repo: Scan repository
    Repo-->>CR: Return standard guideline files
    CR->>CR: Parse & merge with path/AST instructions
    CR-->>Dev: Produce enhanced review

## Proposed File Changes

### docs/guides/review-instructions.md(MODIFY)

Insert a new H2 section `## Standard Coding Guideline Files {#standard-coding-guidelines}` immediately after the existing Path-based Instructions block.

Section outline:
1. Introductory paragraph explaining automatic discovery and why it helps.
2. Fenced code block listing supported patterns exactly as:

**/.cursorrules
.github/copilot-instructions.md
**/CLAUDE.md
*/.cursor/rules/
**/.windsurfrules
*/.clinerules/
**/.rules

3. Bullet explanation of how CodeRabbit loads these files and that users need not manage parsing.
4. Sub-section **UI Controls** detailing navigation `Configuration > Review > Settings > Coding Guidelines`, describing the enable/disable toggle and "Add File" control; include a Markdown image placeholder: `![Coding Guidelines UI](../img/ui-coding-guidelines.png)`.
5. Sub-section **YAML Configuration (optional)** with sample block:
```yaml
reviews:
  standard_coding_guidelines:
    enabled: true  # set to false to disable
    additional_files:
      - "docs/team-guidelines.md"
      - "guides/rules/extra.clinerules"

Note precedence (YAML overrides UI) and cumulative behaviour with existing path/AST instructions.
6. Tip call-out reminding that the feature complements current review instructions.
7. Placeholder note saying screenshots will be added once UI is finalized.

docs/getting-started/configure-coderabbit.md(MODIFY)

Within the section that explains YAML configuration options, add a short paragraph and anchor link:

• Mention new reviews.standard_coding_guidelines block, its enabled boolean, and additional_files list.
• Point readers to Guides → Review Instructions → Standard Coding Guideline Files for full details.
  Place this just after the existing bullet list that introduces common reviews sub-keys.

docs/changelog.md(MODIFY)

References:

• docs/guides/review-instructions.md(MODIFY)

Add a new entry at top of file:

## {{CURRENT_DATE}}

### Standard Coding Guideline Files Support

We're excited to announce automatic support for standard coding guideline files!  
**Key capabilities:**
- Detects `.cursorrules`, `.github/copilot-instructions.md`, `CLAUDE.md`, `.cursor/rules/*`, `.windsurfrules`, `.clinerules/*`, and `.rules` out of the box.
- Uses these guidelines to sharpen AI-powered code reviews.
- Simple toggle to enable or disable the feature in the UI.
- Option to add extra custom guideline files.
- Works alongside existing path-based and AST-based instructions.

Read more in our [Review Instructions guide](./guides/review-instructions.md#standard-coding-guidelines).

Replace {{CURRENT_DATE}} with actual release date before merge.

## Developer Humor

> A repo walks into a bar with a `.cursorrules` file.
> Bartender says, We don’t serve your type here!
> Repo replies, No worries—CodeRabbit already read my guidelines and made me refined. 🐇✨
---


<details>
<summary>Execution Information</summary>

**Branch**: [main](https://github.com/coderabbitai/coderabbit-docs/tree/main)
**Commit**: 228e9f5b8634f2cb7b7172359740a19a70962763
</details>
<!-- traycer_tip_section_start -->

---


<details>
<summary>:bulb: Tips</summary>


### Supported Commands (Inside Comments)
- Use `@traycerai generate` to iterate on the previous version of the implementation plan.

### Supported Commands (Inside Description)
- Add `@traycerai ignore` anywhere in the ticket description to prevent this ticket from being processed.
- Add `@traycerai branch:<branch-name>` anywhere in the ticket description to specify the target branch for the implementation plan.

### Community

- Join our [Discord Community](https://traycer.ai/discord) to get help, request features, and share feedback.
- Follow us on [X/Twitter](https://twitter.com/traycerai) for updates and announcements.

</details>

<!-- traycer_tip_section_end -->
<!-- traycer_plan_end -->
<!-- traycer_root_comment_end -->