mr-description-generator

Generate markdown MR/PR descriptions from git branch changes.

Updated Dec 4, 2025
One-click install
npx skills add https://github.com/maxmurr/htms --skill mr-description-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: mr-description-generator
Source: https://github.com/maxmurr/htms/tree/main/.claude/skills/mr-description-generator
Command: npx skills add https://github.com/maxmurr/htms --skill mr-description-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about mr-description-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate merge request descriptions from git commits?

Automated MR description generation analyzes commits and diffs between branches to produce structured markdown descriptions. This Skill gathers branch information via git commands, classifies change types, and outputs a comprehensive description with a compliance checklist, eliminating manual documentation work and ensuring consistency.

Can I generate PR descriptions that include a compliance checklist?

Yes. The generated descriptions include an integrated compliance checklist covering file structure, naming conventions, data fetching, forms, documentation, and code quality standards. This ensures reviewers can quickly verify adherence to project standards alongside understanding the changes.

What information does the tool extract from git to build the description?

The Skill uses git commands to gather branch information, analyze commits and diffs against a target branch like develop or main, identify change types and affected components, and evaluate overall impact. This data feeds into the structured template to produce detailed, context-aware descriptions.

How do I compare my branch against develop or main before submitting?

Specify your target branch—develop, main, or another—when running the Skill. It analyzes all commits and changes on your current branch relative to the target, classifying them as features, fixes, refactors, docs, or configuration changes, then outputs the structured description.

Does this work with different git workflows or branching strategies?

The Skill analyzes changes between any two branches using standard git commands. It adapts to your branching strategy by letting you specify the target branch for comparison, making it compatible with git flow, trunk-based development, or other workflows.

What happens if my branch has no changes or complex diffs?

The Skill processes any branch state accessible via git. It analyzes available commits and diffs; if changes are minimal or absent, the generated description reflects that. Complex diffs are classified by type and component, so reviewers see structured insights regardless of change volume.