---
name: engineering-change-descriptions
description: 'Use when writing, rewriting, or reviewing PR/CL descriptions, commit messages, or code-change summaries that explain what changed and why. TRIGGER on "write PR description", "improve this commit message", "summarize this diff", "CL description", "change description", or "make this PR/CL description easier to review". DO NOT TRIGGER for code review, PR splitting, code restructuring, user-facing changelogs, or reviewer replies unless the requested output is a change description.'
title: engineering-change-descriptions
canonical_url: https://skilld.dev/gh/minimax-ai/mcode-stack/engineering-change-descriptions
last_updated: 2026-10-29T09:48:02.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> If the user asked to install this Skill, run `npx skilld install minimax-ai/mcode-stack/engineering-change-descriptions`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/engineering-change-descriptions`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/minimax-ai/mcode-stack/engineering-change-descriptions) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/engineering-change-descriptions`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/engineering-change-descriptions --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/engineering-change-descriptions --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Engineering Change Descriptions

A change description is permanent engineering history. It should let reviewers understand the change now and help future maintainers find and understand it later.

Adapted from Google Engineering Practices Documentation, especially "Writing good CL descriptions." Source: <https://google.github.io/eng-practices/review/developer/cl-descriptions.html>. License: CC-BY 3.0.

## What a Good Description Answers

- What changed?
- Why did it change?
- What context, constraints, or tradeoffs are not obvious from the code?
- How was it tested?
- What risks, migrations, rollbacks, or follow-ups should reviewers know?

Even small changes deserve context when the reason is not obvious.

## First Line

The first line should:

- Stand alone in version control history.
- Be short, specific, and focused on what the change does.
- Use an imperative form when writing a commit or CL title.
- Avoid vague labels like "fix bug", "cleanup", "phase 1", "misc", or "add helpers".
- Be followed by a blank line when there is a body.

## Body

Include only useful context:

- Problem being solved.
- Why this approach was chosen.
- User-visible or developer-visible behavior changes.
- Important implementation notes.
- Known limitations or follow-up work.
- Bug IDs, issue links, benchmark results, design docs, migration docs, or rollout plans.
- Enough context for links that might later become inaccessible.
- Test commands and results, when appropriate.

Before submitting, reread the description after review changes and make sure it still matches the final diff.

## Templates

### Standard PR

```markdown
[Imperative one-line summary]

## Why
[Problem, user need, production issue, maintainability reason, or design context.]

## What Changed
- ...
- ...

## Testing
- ...

## Risk / Rollback
- Risk:
- Rollback:
```

### Small Change

```markdown
[Imperative one-line summary]

[One paragraph explaining why this change exists and any non-obvious context.]

Testing: [command or manual check]
```

### Refactor

```markdown
[Describe the structural change and what it replaces]

This prepares for [future change] by [specific reason], without intentionally changing behavior.

Testing: [existing or new tests that protect behavior]
```

### Generated or Mechanical Change

```markdown
[Describe the mechanical rewrite]

Generated by [tool/version/command] to [reason]. Manual edits: [none/list].

Verification: [format/test/build command]
```

## Rewrite Checklist

When improving an existing description:

1. Extract the actual behavior from the diff.
2. Replace vague first lines with a concrete action.
3. Add the missing why.
4. Preserve useful issue links and test evidence.
5. Remove process noise that does not help reviewers or future maintainers.

## Common Mistakes

- Describing only the implementation without the reason.
- Writing a title that future searchers cannot distinguish from similar changes.
- Depending entirely on external links for crucial context.
- Leaving the description stale after review significantly changes the diff.
- Hiding risk, limitations, or rollout requirements because they feel inconvenient.

---

*Also published in [agentara/skills](https://github.com/agentara/skills/tree/main/skills/engineering) (MIT, Copyright (c) 2026 agentara) by the same author. The content is adapted from Google Engineering Practices under CC-BY 3.0; see the source note above. Full notices: [`NOTICE.md`](../../NOTICE.md).*
