Review - Your PR Reviewer

Qodo Gen's /review command empowers developers to streamline collaboration, categorize changes effortlessly, and deliver insightful feedback throughout the review process. This versatile tool elevates code reviews to a new level, ensuring quality and fostering a productive development workflow.

What is the /review command?

The /review command serves as your automated code analysis companion. It streamlines code reviews by offering a comprehensive analysis of pull requests (PRs). Here's how it empowers you:

  • Intelligent change categorization: Effortlessly categorizes the types of changes implemented (e.g., bug fixes, feature additions, refactoring).
  • Automated feedback generation: Provides insightful feedback on potential issues or areas for improvement within the code.
  • Effort estimation: Generates an estimated effort level for reviewing the changes, allowing developers to prioritize their time effectively.

This holistic approach empowers efficient code reviews, improved code quality, and smoother development workflows within your team.

How to Use /review Command for a PR

The /review command is your go-to tool for efficient and insightful code reviews in Qodo Gen's IDE. Follow these simple steps to leverage the power of this command and elevate your code review process:

  • Access PR Assistant in Qodo Gen's IDE: Ensure you have Qodo Gen's IDE plugin installed and activated in your integrated development environment (IDE). Open the qodo’s Chat window and choose a relevant context under the workspace context dropdown.Access PR Assistant in Qodo Gen's IDE
  • Initiate the /review Command: Start by typing /review in the chat window and submit the command. This action triggers the analysis of your local branch changes (local changes or committed, etc., based on the selected context) against an upstream branch.
    Example:
    /review [ optional extra instructions ]Initiate the /review Command
  • Review the Generated Analysis: Within seconds, Qodo Gen analyzes your PR changeset and crafts a beautiful yet comprehensive response. Review the Generated Analysis

Components of the /review command

The /review command offers a multifaceted analysis of pull requests (PRs), empowering efficient code reviews. Here's a breakdown of its key components:

Changes Analysis

  • Main Theme: The command intelligently extracts and communicates the central theme or driving purpose behind the modifications within the PR.
  • Changes Labels: Leverages AI to categorize the changes implemented (e.g., "bug fix," "enhancement," or "refactoring"), ensuring clear identification of change types.
  • Changes Summary: Provides a concise overview of the code modifications, offering reviewers a quick grasp of the alterations introduced.
  • Relevant Tests Added: Indicates whether the changes are accompanied by relevant unit or integration tests, contributing to improved codebase reliability.
  • Estimated Effort to Review: Assigns an estimated effort level (typically on a scale of 1 to 5) to review the changes. This empowers developers and reviewers to prioritize their time effectively.

Changes Feedback

  • General Suggestions: Provides constructive feedback and improvement recommendations to guide developers in elevating overall code quality.
  • Security Concerns: Identifies and communicates potential security vulnerabilities introduced by the code changes within the PR.
  • Changes Score: Generates a numerical score that summarizes the overall impact and quality of the modifications in the PR. This score serves as a quick indicator for reviewers.

Conclusion

By offering a holistic view of changes, insightful feedback, and effort estimations, /review empowers developers to collaborate on code reviews more efficiently, ultimately leading to improved code quality and smoother development workflows. Embrace /review and usher in a new era of intelligent and efficient code review practices within your team.