changelog
File an Unreleased changelog entry for user-visible changes and cut release notes. Use when a PR changes shipped behavior or when cutting vX.Y.Z notes.
- License 许可
- GPL-3.0
- 最近更新
- 2026-11-15
- Stars
- ★ 2
- Forks
- 1
01 前言 Front Matter
- name
- changelog
- description
- File an Unreleased changelog entry for user-visible changes and cut release notes. Use when a PR changes shipped behavior or when cutting vX.Y.Z notes.
02 资源文件 1
- 参考文档agents/openai.yaml228 B
03 SKILL.md 正文
Changelog entries and release notes
Every user-visible change files its own entry under ## Unreleased in
CHANGELOG.md. The release PR moves those entries into a version section;
the tag workflow publishes that section as the GitHub Release body. CI
enforces all three steps — this skill tells an agent how to comply.
What belongs in an entry
- The user-visible outcome: what a user of the packages gets, plus its boundary (limits, defaults, affected surfaces).
- Imperative voice: start bullets with
Add,Keep,Fix,Let,Remove. - Roughly 80-column wrap with two-space continuation lines.
- Inline code for config keys, tool names, flags, and commands.
- No PR numbers, issue links, or implementation narrative.
What does not belong
chore(release)version bumps and dependency-bump churn with no user-visible effect.- CI-only, test-only, and docs-only changes.
- Internal refactors with no observable behavior change.
Where it goes
Add bullets under ## Unreleased at the top of CHANGELOG.md. One bullet
per user-visible change; aggregate related commits rather than transcribing
the log.
Escape hatch (honest use only)
When the PR genuinely has no user-visible change, either carry the
skip-changelog label or put a Changelog: none line in the PR body. Never
use the hatch to skip documenting a user-visible change.
Cutting release notes
Cut the accumulated entries before bumping any version:
node scripts/release/cut-changelog.mjs --version X.Y.Z --title "Short theme" --check
node scripts/release/cut-changelog.mjs --version X.Y.Z --title "Short theme"
pnpm run check:changelog
The script refuses an empty Unreleased, a duplicate or non-greater
version, a bad date, and a malformed file. It never edits older sections.
Checks
pnpm run check:changelog— structure, published-version coverage, and (in a ready-for-review PR) the new-entry rule. A draft PR defers the entry rule until it is marked ready for review; structure and coverage still run on every PR and on pushes.vitest run scripts/__tests__/check-changelog.test.mjswhen touching the check; the release-side file underscripts/release/__tests__/when touching the release scripts.
04 同仓库更多 Skills
worktree-feature
Start isolated mono-agent work with diff-aware setup, keep only required dist fresh, and ship through a PR with safe cleanup. Use for tracked repository changes, multi-commit work, or before executing an implementation plan.
verify-green
Select and run the smallest risk-based verification lane that proves a mono-agent change. Use before claiming a change works, before committing or opening a PR, or when asked to verify, run the gate, make it green, or check architecture.
repo-hygiene-gc
Explicit bulk branch/worktree garbage collection using API-bound deletion proof. Use when asked to clean up the repository or run a deliberate maintenance sweep; ordinary PR cleanup belongs to worktree-feature.
release-lockstep
Cut and registry-verify a lockstep npm release of all @mono-agent packages. Use when asked to release, publish to npm, cut vX.Y.Z, or bump the version. A release never implies consumer deployment.
pi-upstream-recon
Investigate the vendored pi packages' real API surface (pi-ai and pi-agent-core) before hand-rolling anything, and run pi version bumps safely. Use before implementing runtime/provider/session behavior, when pi behavior is surprising, or when asked to "bump pi".
ops-log-hygiene
Check bounded logs for explicitly restarted services, or run a full log-health audit when requested or when symptoms justify it. Use for crash-loop diagnosis, oversized logs, restart churn, or an explicit live-fleet log audit.