Merge branch 'main' into feature/issues/331

Author: syedalinaqihasni

docs/changelog.md

@@ -5,6 +5,46 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 13
 ---
 
+## July 3, 2025
+
+### Enhanced Python Static Analysis: Flake8 Support
+
+We're excited to announce enhanced Python static analysis capabilities with [Flake8](https://flake8.pycqa.org/) support!
+
+[Flake8](https://flake8.pycqa.org/) is a Python linting utility that wraps PyFlakes, pycodestyle, and Mccabe to check your Python code for style and logical errors.
+
+See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details.
+
+## July 1, 2025
+
+### Enhanced Code Guidelines Support
+
+We've expanded our code guidelines scanning capabilities to provide even better code review experiences. CodeRabbit now automatically scans and learns from additional configuration files to understand your organization's coding standards and preferences.
+
+**New supported patterns:**
+
+- `**/.cursorrules` - Cursor IDE rules and preferences
+- `.github/copilot-instructions.md` - GitHub Copilot instructions
+- `**/CLAUDE.md` - Claude-specific coding guidelines
+- `**/.cursor/rules/*` - Cursor rules directory
+- `**/.windsurfrules` - Windsurf IDE rules
+- `**/.clinerules/*` - Cline IDE rules
+- `**/.rules/*` - General rules directory
+
+These guidelines are automatically analyzed and applied during code reviews to ensure consistency with your team's coding standards. You can configure these patterns in the knowledge base section of your CodeRabbit settings.
+
+## June 27, 2025
+
+### Enhanced PHP Static Analysis: PHPMD and PHPCS Support
+
+We're excited to announce enhanced PHP static analysis capabilities with two powerful new tools!
+
+- [PHPMD](https://phpmd.org/) (PHP Mess Detector) is a static analysis tool that detects potential problems in your PHP code such as possible bugs, suboptimal code, overcomplicated expressions, and unused parameters, variables, methods, and classes.
+
+- [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer) (PHP CodeSniffer) is a development tool that ensures your PHP code conforms to coding standards like PSR-1, PSR-2, PSR-12, and custom standards. It can automatically fix many coding standard violations.
+
+See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details.
+
 ## June 11, 2025
 
 ### Enhanced Static Analysis: HTMLHint and Checkmake Support

docs/faq.md

@@ -205,12 +205,13 @@ In-trial and open-source plans have lower rate limits than the paid plan. In all
 
 The following limits enforced _per developer_:
 
-| Feature          | Free Plan                                  | Trial Plan                    | OSS Plan                      | Pro/Lite Plan                 |
-| ---------------- | ------------------------------------------ | ----------------------------- | ----------------------------- | ----------------------------- |
-| Files per hour   | 200/hour                                   | 200/hour                      | 200/hour                      | 400/hour                      |
-| Files per PR     | 100                                        | 100                           | 100                           | 200                           |
-| Reviews per hour | 3 back-to-back, then 2/hour (Summary only) | 4 back-to-back, then 3/hour   | 3 back-to-back, then 2/hour   | 5 back-to-back, then 4/hour   |
-| Chat             | N/A                                        | 25 back-to-back, then 50/hour | 10 back-to-back, then 25/hour | 25 back-to-back, then 50/hour |
+| Feature                          | Free Plan                                  | Trial Plan                        | OSS Plan                      | Pro/Lite Plan                 |
+| -------------------------------- | ------------------------------------------ | --------------------------------- | ----------------------------- | ----------------------------- |
+| Files per hour                   | 200/hour                                   | 200/hour                          | 200/hour                      | 400/hour                      |
+| Files per PR                     | 100                                        | 100                               | 100                           | 200                           |
+| Reviews per hour                 | 3 back-to-back, then 2/hour (Summary only) | 4 back-to-back, then 3/hour       | 3 back-to-back, then 2/hour   | 5 back-to-back, then 4/hour   |
+| Reviews per hour (IDE Extension) | 1/hour                                     | 5/hour (Pro trial), 1/hour(Other) | 1/hour                        | 5/hour (Pro), 1/hour(Lite)    |
+| Chat                             | N/A                                        | 25 back-to-back, then 50/hour     | 10 back-to-back, then 25/hour | 25 back-to-back, then 50/hour |
 
 ## Integration Guide {#integration-guide}
 

docs/guides/config-vscode.md

@@ -14,11 +14,11 @@ The instructions on this page are specific to using the extension with VSCode. I
 
 To navigate to the settings screen for the CodeRabbit VSCode extension, follow these steps:
 
-1. In the activity bar, click the Extensions icon.
+1. Open the CodeRabbit activity bar/sidebar.
 
-1. In the sidebar, under **Installed**, click the gear-shaped **Manage** icon in the CodeRabbit row.
+1. In the sidebar, click on gear shaped icon on top right(beside logout icon).
 
-1. In the menu that appears, select **Settings**.
+1. You can also search for CodeRabbit: Settings in the command palette to open the settings.
 
 The settings screen contains the following configuration controls.
 
@@ -32,6 +32,14 @@ The **Agent Type** setting lets you choose the extension's response to using the
 
 - **Claude Code**: The extension opens the Terminal pane of your IDE and tries to use the `claude` command-line program to apply the suggested fix to your code. You need to have Claude Code installed for this option to be effective.
 
+- **Codex CLI**: The extension opens the Terminal pane of your IDE and tries to use the `codex` command-line program to apply the suggested fix to your code. You need to have Codex CLI installed for this option to be effective.
+
+- **Cline**: The extension opens the `Cline` sidebar and runs a task to apply the suggested fix to your code. You need to have the `Cline` extension installed for this option to be effective.
+
+- **Roo**: The extension opens the `Roo` sidebar and runs a task to apply the suggested fix to your code. You need to have the `Roo` extension installed for this option to be effective.
+
+- **Kilo Code**: The extension opens the `Kilo Code` sidebar and runs a task to apply the suggested fix to your code. You need to have the `Kilo Code` extension installed for this option to be effective.
+
 - **Clipboard**: The extension copies prompt text describing the suggested fix to your clipboard. From there, you can manually paste the prompt into the coding AI agent that you use with your IDE.
 
 For more information about the **Fix with AI** feature, see [Request help from your AI coding agent](/guides/use-vscode#agent).

docs/guides/custom-reports.md

@@ -295,6 +295,166 @@ Issues and tickets brings in conversations, descriptions, and comments from Jira
     - `<issue_description>`: markdown - The description of the issue.
     - `<issue_comments>`: array of comment objects - Contains all the comments made on the issue.
 
+#### Remove PRs without a "Score Card/Chart" bot comment
+
+This option gives you the ability to create a report limited only to pull requests containing a "Score Card" or "Score Chart" bot comment from CodeRabbit or other bots. To enable issues and tickets you must include the tag `<pr_score_card>` in your prompt.
+
+> **IMPORTANT:** This will automatically remove any pull requests from your reports if they do not contain a "Score Card" or "Score Chart" bot comment. Using this option without setting up a flow to create these comments will result in `No new pull request activity in the last XYZ hours` errors. Do not enable this option unless you have created a "Score Card" or "Score Chart" bot comment flow.
+
+For example you can ask coderabbit to check serveral conditions on a pull request and produce a "Score Chart":
+
+<details>
+<summary>Click to view example User Score Card/Chart Comment:</summary>
+
+![Score Card/Chart Trigger Comment Example](/img/guides/score-card-trigger-comment.png)
+
+```markdown
+@coderabbitai
+Use the <overall_instructions> to guide the content of the summary. Use the format shown in <\_example> but do not include or refer to the example's content in the final summary/report.
+
+<overall_instructions>
+
+**Instructions:**
+Generate a weekly code review report for the author of this pull request only following scoring parameters. Calculate the scores and compile the results into a table so that the team-wise average score can be easily determined.
+**Scoring Parameters:**
+
+1. **Basic Code Standards (Score out of 2)**
+
+   - Avoidance of hard-coded values
+   - No repetition of code (DRY principle)
+
+2. **Code Readability (Score out of 2)**
+
+   - Presence of meaningful comments
+   - Proper variable declaration using `const` and `let`
+
+3. **Error Handling (Score out of 4)**
+
+   - Handling failure scenarios (e.g., try-catch, fallbacks)
+   - Proper loading state implementation (e.g., button click loading states)
+   - Handling edge cases (e.g., checking for undefined or missing values)
+   - Input validation (ensuring correct user inputs)
+
+4. **Circle CI Check Validation (Score: 0 or 1)**
+   - `0` → Not Passed
+   - `1` → Passed
+
+**Final Score Calculation:**
+Combine the scores from the parameters above to derive the final code quality score (out of 5).
+**Output Format:**
+Provide the final report in a table format with the following columns (use shorthand notations), be sure to include this list at the top above the chart in the "Column Notation" section so users understand what the columns mean:
+
+- **User Name (User)**
+- **Basic Code Standards (BCS) (out of 2)**
+- **Code Readability (CR) (out of 2)**
+- **Error Handling (EH) (out of 4)**
+- **Shopify Theme Check (CI) (out of 1)**
+- **Final Code Quality Score (FCQS) (out of 9)**
+
+</overall_instructions>
+
+<\_example>
+
+## Column Notation
+
+- **User Name (User)**
+- **Basic Code Standards (BCS) (out of 2)**
+- **Code Readability (CR) (out of 2)**
+- **Error Handling (EH) (out of 4)**
+- **Shopify Theme Check (CI) (out of 1)**
+- **Final Code Quality Score (FCQS) (out of 9)**
+
+## Score Chart
+
+| User     | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) |
+| -------- | ------- | ------ | ------ | ------ | -------- |
+| John Doe | 2       | 3      | 2      | 1      | 9        |
+
+</\_example>
+```
+
+</details>
+
+Then CodeRabbit will reply with a score for you pull request:
+
+<details>
+<summary>Click to view resulting Score Card/Chart bot comment:</summary>
+
+![CodeRabbit Score Card/Chart Result Comment Example](/img/guides/score-card-result-comment.png)
+
+</details>
+
+You can then utilize this in a report. We recommend your report looks specifically for these score cards and puts together a unified report:
+
+<details>
+<summary>Click to view example Report Prompt when using Score Card/Chart:</summary>
+
+![Report Example](/img/guides/score-card-report-result.png)
+
+![Where to put this prompt](/img/guides/where-score-report-prompt-go.png)
+
+Prompt Example:
+
+```markdown
+Use the <overall_instructions> to guide the content of the summary. Use the format shown in <example> but do not include or refer to the example's content in the final summary/report.
+
+<overall_instructions>
+**Instructions:**
+
+Locate the score chart comment in the <bot_comments>. There will be a single comment with data on these fields:
+
+- **User Name (User)**
+- **Basic Code Standards (BCS) (out of 2)**
+- **Code Readability (CR) (out of 2)**
+- **Error Handling (EH) (out of 4)**
+- **Shopify Theme Check (CI) (out of 1)**
+- **Final Code Quality Score (FCQS) (out of 9)**
+
+These details may also be in the form of a chart such as:
+
+## Score Chart
+
+| User     | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) |
+| -------- | ------- | ------ | ------ | ------ | -------- |
+| John Doe | 2       | 3      | 2      | 1      | 9        |
+
+You will create a new chart averaging all the values from various pull requests for each author. Only include pull requests with a `Score Chart`. Do not invent or create score charts if none exist.
+
+</overall_instructions>
+
+<example>
+
+## Column Notation
+
+- **User Name (User)**
+- **Basic Code Standards (BCS) (out of 2)**
+- **Code Readability (CR) (out of 2)**
+- **Error Handling (EH) (out of 4)**
+- **Shopify Theme Check (CI) (out of 1)**
+- **Final Code Quality Score (FCQS) (out of 9)**
+
+## Score Chart
+
+| User     | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) | PR URL |
+| -------- | ------- | ------ | ------ | ------ | -------- | ------ |
+| John Doe | 2       | 3      | 2      | 1      | 9        | URL    |
+| Alex Foo | 2       | 3      | 2      | 1      | 9        | URL    |
+
+</example>
+<include_bot_comments>
+<pr_score_card>
+```
+
+</details>
+
+**Best Practices for Score Cards/Charts:**
+
+- The reporting bot only has access to your comments and summary (like a project manager) if you want to make a report looking for these score card/chart comments make sure the reviewer does this ahead of time.
+- Only include checks for very specific scenarios, such as a specific check failing or using tabs vs spaces.
+- Do not use general rules without explaining specifically what they mean. If you add "Insure the pull request follows development best practices" you must define what "development best practices" actually mean or the AI will guess.
+- Make one point for each specific check and make sure its a True/False condition.
+- Instead of manually commenting on pull requests you can use the [Github Actions Bot](https://github.com/marketplace/actions/create-or-update-comment) to automatically comment on pull requests and trigger coderabbit score card/chart comments by including `@coderabbit` in the comment.
+
 ## Best Practices
 
 1. **Be Specific**

docs/guides/initial-configuration.md

@@ -77,8 +77,9 @@ By default, CodeRabbit writes thorough code reviews with several sub-sections. I
 
 ## Adjust path-specific CodeRabbit behavior {#path}
 
-These settings direct CodeRabbit to treat various files and and locations in
-your repository differently.
+You can give CodeRabbit additional instructions for reviewing specific files or
+locations in your repository, or configure CodeRabbit to disregard certain file paths
+during code reviews.
 
 For an overview about using path-based instructions in CodeRabbit, see [Path-based instructions](/guides/review-instructions#path-based).
 

docs/guides/use-vscode.md

@@ -18,7 +18,7 @@ You can let CodeRabbit automatically review commits that you make to your local
 
 To perform an automatic review, follow these steps:
 
-1. Perform a Git commit using VSCode. After you do this, a dialog appears in your VSCode window, asking **Would you like to start a review?**
+1. Perform a Git commit using VSCode or terminal. After you do this, a dialog appears in your VSCode window, asking **Would you like to start a review?**
 
 1. Click **Yes**. The CodeRabbit sidebar appears in your VSCode window.