跳到主要内容
知仓学习社ZHICANG

changelog

Record shipped work in the monthly changelog (append-only). Use when something ships or when asked "what changed", "add to changelog", "release note…

不碰外部(只输出文字)无严重或高危命中hashgraph-online/awesome-codex-plugins

它会碰到什么

扫了多少1 个文本文件,4 KB
它会碰到什么不碰外部(只输出文字)
命中总数0 处
命中统计严重 0 · 高 0 · 中 0 · 低 0

这一栏是扫描器报的事实,不是结论。命中多不等于有毒(安全工具、规则库、示例脚本本来就会包含危险写法),命中少也不等于干净。它和你手上的凭据、文件、网络有什么关系,需要你自己看。

技能内容

changelog

The memory of the knowledge base. Every month gets one file; history is append-only. This is what the SessionStart hook surfaces so the agent starts each session knowing recent work. Pairs with [author](../author/SKILL.md) and [router](../router/SKILL.md).

> Golden rule: never delete or rewrite shipped history. Reversals get a new entry, not an edit.

Writing style (enforce)

Direct, tech + business. No filler. Outcome first.

  • Each entry = a small table (Outcome / Delivered / Business impact / Commits). No narrative paragraphs.
  • Summary = 4 bullets max: release type, biggest business change, biggest technical change, prod risk/action.
  • Concrete only: feature names, paths, hashes, numbers. Cut adjectives.

1 — One file per month

changelog/(mmm-yy).md — lowercase 3-letter month + 2-digit year: (apr-26).md, (may-26).md.

changelog/README.md is the index: a table of | Month | Highlights |, newest first.

Link to a month file (parens need angle brackets): [may-26](<(may-26).md>).


2 — Anatomy of a month file

# Month YEAR — <release / period title>

> Window: `<base>` (`hash`, date) → `<head>` (`hash`, date). Scope: `N` commits.

## Summary
- Release type: patch | feature | architectural
- Biggest business change: <one line>
- Biggest technical change: <one line>
- Risk / action for prod: <one line>

## What Changed

### 1. <Feature / theme>
| | |
|---|---|
| Outcome | <one line> |
| Delivered | <bullet; bullet> |
| Business impact | <one line> |
| Commits | `<hash>` <desc>; `<hash>` <desc> |

### 2. <next theme>

A reader skimming the Outcome rows alone should understand the release.


3 — The shipping flow (where changelog fits)

The roadmap (plans/upcoming/) and the changelog are two ends of one pipe:

plans/upcoming/{critical,now,next,later}.md   ── ships ──►   changelog/(mmm-yy).md
        (what's coming)                                        (what landed)

When something ships:

  1. Move the line out of the plans/upcoming/* horizon — don't let shipped work linger there (it kills the roadmap's signal).
  2. Add / update the entry in the current changelog/(mmm-yy).md.
  3. Cross-link: the feature plan's ## What shipped table references the changelog month; the ADR/spec stay linked from the plan.
  4. If a known bug got fixed, move it from reviews/bugs/open.md to reviews/bugs/fixed.md with the commit ref.

plans/upcoming/README.md keeps a short "Recently shipped" pointer list to the last few months — pointers only, no restating.


4 — Generating an entry from git

To build a month/release entry, diff the two refs and group commits by theme:

# commits in head not yet in base, newest first
git log --no-merges --pretty='%h %ad %s' --date=short BASE..HEAD
# count for the scope line
git rev-list --count --no-merges BASE..HEAD

Then: cluster commits into 3–8 themes → write a ### N. Theme block each → fill outcome / delivered / why / commits → write the Executive Summary last (it summarizes the blocks).


5 — Why append-only matters

The changelog is the project's long-term memory. An agent (or a new teammate) that reads the newest one or two month files gets the recent trajectory: what was built, why it mattered, which commits. Editing or pruning old months erases that trail. Superseded decisions are recorded as new lines that reference the old — the history of the change is itself information.

想直接用这个技能?

本站把开放许可(MIT / Apache 等)的技能按仓库打包整理到网盘,点一下转存到你自己的网盘,不用一个个从 GitHub 拉。许可未声明的技能只给原始仓库链接,不打包。

同名技能的其他版本

有 2 个不同仓库或目录里都有叫 changelog 的技能。它们内容并不相同,别混用: