changelog
Write the changelog entry for a pull request. Use when a PR changes behavior that users, operators, or integrators can notice.
- License 许可
- MIT
- 最近更新
- 2026-11-03
- Stars
- ★ 10
- Forks
- 2
01 前言 Front Matter
- name
- changelog
- description
- Write the changelog entry for a pull request. Use when a PR changes behavior that users, operators, or integrators can notice.
03 SKILL.md 正文
<!-- Upstream: github.com/acme/agent-skills @ 3f9c2e1 (synced 2026-09-14) -->
Changelog entries
When a pull request changes something a user can notice, it needs an entry under
## Unreleased in CHANGELOG.md before it merges.
Steps
- Read the diff and the PR description, and decide which section the change belongs to: Added, Changed, Deprecated, Removed, Fixed, or Security.
- Apply the
needs-changeloglabel to the PR so the release captain can find it. - Save drafts to ~/notes/acme/changelog/ until the entry is final, then move the text into
CHANGELOG.md. - Write the entry by the rules below and commit it with the change.
Rules
- Write each entry for the person upgrading, not for the person who wrote the code.
- Start with the verb that says what happened: Added, Changed, Fixed, Removed.
- The reviewer, not the author, decides whether an entry is user-facing.
- When a change breaks existing behavior, say what the reader must do before they upgrade.
- Link the pull request at the end of the entry, never in the middle of the sentence.
04 同仓库更多 Skills
writing-good-tickets
Write, file, or update an issue or ticket that an agent or a developer can take to one PR. Use when filing a bug or feature, updating an issue, or breaking a plan into tickets.
writing-good-prs
Write or update a pull request title and body that a reviewer can trust and own. Use when opening a PR or editing its description.
writing-good-commits
Write or reword a git commit message and size the commit it describes. Use when committing, or when reshaping commits during a rebase.
writing-for-agents
Writing documents for agents. Use when creating or editing skills, or modifying AGENTS.md or CLAUDE.md.
wizard
Generate an interactive bash wizard that walks a human through steps only they can perform. Use when provisioning infrastructure, setting up credentials or CI secrets, walking an unfamiliar third-party dashboard, or running a one-off migration or cutover. Don't invoke this for steps the agent can perform itself.
why
Use for 'why does X work this way', 'why we picked Y', design rationale, regressions, postmortems, or data-backed thresholds. Use how for runtime behavior.