changelog-writer
Skill1 starsChanged 8 months agoMITView on GitHub
Write concise architecture-focused milestone changelogs for implementation work. Use when a user asks to document what was delivered, include Mermaid diagrams, present DB schema in tables with clear field roles, and add links to relevant files/endpoints/tests.
21 other projects use a version of this.
Adopted by
Most recently taken up by
- Sagargupta16/agent-recipestheir own version, first seen Nov 1, 2026
- ommakes/Skillstheir own version, first seen Oct 27, 2026
- maximhq/bifrosttheir own version, first seen Oct 20, 2026
- WST2002/claude-code-skillstheir own version, first seen Oct 17, 2026
- anchildress1/awesome-aitheir own version, first seen Oct 13, 2026
- mukundzha/clwstheir own version, first seen Oct 13, 2026
Used with
Projects with it also use regex-builder, test-writer and 1 more.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
jMertaSkillregex-builder
Use when the user asks to create, debug, explain, validate, or optimize a regular expression or replacement for a specific engine. Verifies representative matches, non-matches, captures, escaping, portability limits, and backtracking risk in the target runtime.
Also in 3 projects that use this
leonardomsoSkilltest-writer
Generate comprehensive Vitest tests for code examples in JavaScript concept documentation pages, following project conventions and referencing source lines
Also in 5 projects that use this
glinckerSkillreadme-generator
Generates comprehensive README.md files for software projects by analyzing codebase structure
Also in 6 projects that use this
Other versions21 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 21
- maximhq/bifrost★ 9.4ksame name
- jihe520/mindpocket★ 349same name
- hamzafarooq/claude-code-starter★ 145same name
- anchildress1/awesome-ai★ 67same name
- anchildress1/awesome-github-copilot★ 67same name
- ommakes/Skills★ 21same name
- zbruhnke/claude-code-starter★ 16same name
- jaredpalmer/skills★ 8same name
- carlkibler/agent-skills★ 6same name
- kevinaimonster/skill-hub★ 4same name
11 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository25 other files it gives its agents.
- AGENTS.mdAGENTS.md
- architect-reviewSkill
- brainstormingSkill
- dispatching-parallel-agentsSkill
- documentation-writerSkill
- executing-plansSkill
- fastapiSkill
- makefileSkill
- pgvector-semantic-searchSkill
- postgres-patternsSkill
- python-patternsSkill
- python-testingSkill
- requesting-code-reviewSkill
- ruffSkill
- subagent-driven-developmentSkill
- systematic-debuggingSkill
- task-doc-navigatorSkill
- test-driven-developmentSkill
- tySkill
- using-git-worktreesSkill
- using-superpowersSkill
- uvSkill
- verification-before-completionSkill
- writing-plansSkill
- writing-skillsSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
15 rules. 0 are common, 12 are distinctive, and 3 are very specific to this project.
0
Common
Most of the 19 edited versions we read keep these.
12
Distinctive
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 8
Write changelogs in the same style as project milestone changelogs under docs/changelog/.
- Distinctive: line 12
Read the target plan/spec and implementation files before drafting.
- Distinctive: line 15
Verify every major claim has at least one file link.
- Distinctive: line 19
Keep writing concise and technical.
- Distinctive: line 20
Use Markdown links to concrete repo-relative paths for routes, services, models, migrations, tests, and plans.
- Distinctive: line 21
Prefer repo-relative links by default.
- Very specific: line 22
Never use machine-specific absolute filesystem paths such as /path/to/repo/....
- Distinctive: line 24
Add a schema section with Markdown tables.
- Distinctive: line 25
Call out key tradeoffs and limits without repeating obvious code details.
- Distinctive: line 26
Avoid invented behavior; only document what is implemented.
- Distinctive: line 39
Prefer deep links to the most specific file that proves the point.
- Distinctive: line 40
When useful, include multiple links per bullet (API + core + persistence + test).
- Distinctive: line 41
Keep link lists short and relevant.
- Distinctive: line 42
Keep every link portable across machines by using repo-relative paths or GitHub URLs only.
- Very specific: line 46
Use references/changelog-template.md as the starting structure and adapt headings to the milestone.
“Common” is measured: kept by at least 6 in 10 of the 19 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Changelog Writer
Write changelogs in the same style as project milestone changelogs under docs/changelog/.
Workflow
- Read the target plan/spec and implementation files before drafting.
- Map each delivered behavior to concrete code links.
- Draft a concise changelog using the template in
references/changelog-template.md. - Verify every major claim has at least one file link.
Output Rules
- Keep writing concise and technical; prefer bullets over long paragraphs.
- Use Markdown links to concrete repo-relative paths for routes, services, models, migrations, tests, and plans.
- Prefer repo-relative links by default; GitHub links are acceptable when a hosted deep link is more useful.
- Never use machine-specific absolute filesystem paths such as
/path/to/repo/.... - Include at least one Mermaid diagram (
flowchartorsequenceDiagram) that reflects the real implementation. - Add a schema section with Markdown tables. Each table row must explain field purpose, not only type.
- Call out key tradeoffs and limits without repeating obvious code details.
- Avoid invented behavior; only document what is implemented.
Minimum Sections
- Title + short intro linking the milestone plan/spec.
- Scope Delivered.
- Architecture / Flow (Mermaid).
- Design Notes (major decisions and rationale).
- Schema Reference (table format with clear explanations).
- Verification Notes (tests or checks).
Link Quality
- Prefer deep links to the most specific file that proves the point.
- When useful, include multiple links per bullet (API + core + persistence + test).
- Keep link lists short and relevant.
- Keep every link portable across machines by using repo-relative paths or GitHub URLs only.
Reusable Template
Use references/changelog-template.md as the starting structure and adapt headings to the milestone.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.