mr-description-generator

What problem does it solve?

Manually writing detailed Merge Request (MR) or Pull Request (PR) descriptions is time-consuming and often leads to inconsistent or incomplete documentation. This Skill automates the process, ensuring comprehensive and standardized descriptions every time, saving developers valuable time and improving code review efficiency.

Core Features & Use Cases

• Automated Analysis: Gathers branch information using git commands and analyzes changes to identify their type, affected components, and overall impact.
• Structured Template: Provides a pre-defined Markdown template for consistent, high-quality descriptions, including sections for changes made, summary, and additional notes.
• Compliance Checklist: Integrates a checklist for file structure, naming conventions, data fetching, forms, documentation, and code quality, ensuring adherence to project standards.
• Use Case: Before submitting a merge request, use this Skill to automatically generate a detailed description that helps reviewers understand changes quickly and ensures compliance with project standards, accelerating the review process.

Quick Start

Generate a merge request description for my current branch, comparing it against the 'develop' branch, and include a compliance checklist.