Describe Merge Requests

The Describe feature is an innovative and highly efficient tool designed to streamline the code review process by automatically generating concise and insightful summaries of merge requests (MRs). This powerful feature aids reviewers in rapidly comprehending the essence and impact of the proposed code changes, significantly reducing the time required to review and approve MRs.

Functionality and Usage:

Automatic Description Generation: Upon being triggered automatically, the StarShip CodeReview instantly analyzes the content of the merge request, crafting a comprehensive summary that encapsulates the key objectives, changes, and potential implications of the MR. This summary is then seamlessly incorporated directly into the MR description, ensuring that reviewers have immediate access to a clear and informative overview before delving into a detailed review. Alt text

Manual Note Triggering with Flexible Integration Options:

By Default:Users can initiate the summarizer manually through an MR Note, by default, the generated summary content is appended to an MR Note.
Appending Summary to MR Description: Users have the option to append the summary content into the MR description by setting the {"mode": "append"} as configuration.
```
@codegpt /describe --config={"mode": "append"}
```
Replacing MR Description: For a more streamlined approach, the {"mode": "replace"} configuration allows for the complete replacement of the original MR description with the summary content.
```
@codegpt /describe --config={"mode": "replace"}
```

Note: To ensure you're viewing the latest information regarding your Merge Request (MR), it may be necessary to manually refresh the Merge Request's webpage.