merge-request-etiquette

Writes merge request descriptions with a TLDR, fix summary, and squashed branch workflow.

Updated Aug 4, 2026
One-click install
npx skills add https://github.com/tschallacka/ai-skills --skill merge-request-etiquette-tschallacka
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: merge-request-etiquette
Source: https://github.com/tschallacka/ai-skills/tree/main/merge-request-etiquette
Command: npx skills add https://github.com/tschallacka/ai-skills --skill merge-request-etiquette-tschallacka

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Merge request descriptions often bury reviewers in process noise, chat transcripts, and restated diffs, making it hard to tell what changed and why. This Skill produces descriptions a reviewer can act on: a one-paragraph TLDR, a body naming the defect and fix, and nothing else. ## Core Features & Use Cases - Author-voice writing: The description reads as written by the human whose name is on the request, with no mention of the agent, session, or chat transcripts. - TLDR-first structure: Every description opens with a single short paragraph stating what the change does and why, followed by a concrete body naming the defect, cause, and fix. - Commit-derived content: Reasoning is pulled from git log on the working branch before writing, and the request is opened from a dedicated mr/ branch squashed to one commit whose message is the description. - Conditional collapsible blocks: A <details> section is allowed only for evidence the commits cannot carry, such as a captured upgrade log, under three strict conditions. - Use Case: After finishing a bug fix on a feature branch, ask the agent to open the merge request; it reads the branch commits, writes the TLDR and body, cuts an mr/ branch, squashes, and pushes. ## Quick Start Write the merge request description for my current branch and open it from a squashed mr/ branch.

Frequently Asked Questions about merge-request-etiquette

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

FAQPage Schema
How do I write a good merge request description?▼

Open with a TLDR heading containing one short paragraph stating what the change does and why. Follow with a body naming the defect, its cause, and the fix, derived from the branch's git log rather than restating the diff.

How to squash commits before opening a pull request?▼

Cut a dedicated branch with git checkout -b mr/<subject> from the target, run git merge --squash <working-branch>, and commit once with the TLDR and fix summary. The working branch keeps its full history for reference during review.

Should AI assistance be mentioned in a pull request description?▼

No. The description is written in the first-person voice of the human author whose name is on the request. It never mentions the agent, session, model, or chat transcripts, and never says "as requested" or implies the author took direction.

When is a collapsible details section appropriate in a merge request?▼

Only when three conditions all hold: the content cannot be derived from the commits or diff, a reviewer genuinely needs it as evidence, and the platform renders HTML <details>. Captured upgrade logs or external tool output qualify; chat logs and narratives do not.

What does this skill not cover?▼

It governs only the merge request or pull request description. Commit messages, code review comments, and release notes are out of scope, and projects with their own templates or one-commit-per-change conventions take precedence.