Skip to main content

Review Merge Requests

By conducting thorough examinations of merge requests, this feature adeptly identifies various potential issues, ranging from minor code inefficiencies to critical vulnerabilities, thus offering a spectrum of actionable suggestions designed to refine and improve the code submitted for review.

Review Result​

Review Result Classification:​

The tool categorizes its review outcomes into two distinct types, aimed at offering clear, immediate feedback on the state of the reviewed code:

  • Look Good To Me (LGTM): This classification is a green signal, indicating that the code has met all the quality and security benchmarks set by the organization, and appears to have no substantial issues warranting further improvement before merging. Alt text

  • Need To Be Improved: Contrary to LGTM, this outcome signifies that the code, while possibly functional, falls short of meeting certain quality, performance, or security standards. It highlights areas where enhancements are recommended or required prior to integration. Alt text

Review Comments and Suggestions​

  • In-line Commentary and Suggestions: For issues directly tied to specific lines of code, the tool initiates discussions directly appended to the relevant code lines. This mode of feedback ensures that developers can see the exact context of each comment or suggestion, streamlining the process of making precise corrections or enhancements. Alt text

  • General Review Comments and Suggestions: Not all feedback pertains to specific lines of code. Some insights or suggestions may relate to broader aspects of the codebase or programming practices. For such cases, the tool compiles the feedback into an "Other Review Comments And Suggestions" section. This segment captures overarching suggestions, coding best practices, architectural improvements, or any other advice not tied to a particular code snippet. Alt text

Configuring Custom Instructions​

The StarShip CodeReview tool offers a highly customizable and flexible approach to code review by allowing users to define Custom Instructions tailored to specific rules or criteria essential for their projects. This feature ensures that the code review process aligns perfectly with organizational standards, project-specific requirements, or unique coding practices, enhancing both the efficiency and effectiveness of reviews.

  • Project-Level Configuration: Custom Instructions can be seamlessly integrated at the project level through the DB (Database) configuration page. This centralized approach allows users or team leads to specify unique rules and guidelines once, applying them across all merge requests within a project. Alt text
  • Merge Request-Level Configuration: For a more tailored review experience, users have the option to specify Custom Instructions directly within the note of a merge request. This level of granularity is particularly useful for addressing unique challenges or exceptions that a project-level configuration might not cover. Alt text

By allowing for the specification of Custom Instructions, StarShip CodeReview ensures that the code not only meets general quality standards but also adheres to the unique requirements or coding practices of the project or organization.