agentleFS
modeled-information-formatmodeled-information-format/mif-docs-plugin/skills/changelog/SKILL.md

changelog

Skill1 starsChanged 35 days agoMITView on GitHub

Write or update a CHANGELOG in the Keep a Changelog 1.x format — a human-curated, reverse-chronological record of notable changes per released version, grouped by Added/Changed/Deprecated/Removed/Fixed/Security and versioned with SemVer. Use when the user needs release notes or a version history humans will read. Anti-trigger; not for forward-looking roadmaps, marketing release announcements, or a raw dump of git commit log lines.

160 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use playtest-report, soak-test and 10 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.
  • CoralGameSkill

    playtest-report

    Generates a structured playtest report template or analyzes existing playtest notes into a structured format. Use this to standardize playtest feedback collection and analysis.

    Also in 12 projects that use this

  • lilangMaxSkill

    soak-test

    Generate a soak test protocol for extended play sessions. Defines what to observe, measure, and log during long play sessions to surface slow leaks, fatigue effects, and edge cases that only appear after sustained play. Primarily used in Polish and Release phases.

    Also in 9 projects that use this

  • lilangMaxSkill

    team-live-ops

    Orchestrate the live-ops team for post-launch content planning: coordinates live-ops-designer, economy-designer, analytics-engineer, community-manager, writer, and narrative-director to design and plan a season, event, or live content update.

    Also in 9 projects that use this

  • CoralGameSkill

    team-polish

    Orchestrate the polish team: coordinates performance-analyst, technical-artist, sound-designer, and qa-tester to optimize, polish, and harden a feature or area for release quality.

    Also in 14 projects that use this

  • +5 more from lilangMax
  • +3 more from CoralGame

The file

We split this skill into the rules it gives an agent

3 rules. 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 149 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Follow SemVer: breaking changes bump MAJOR, features MINOR, fixes PATCH.

    line 34
  2. Distinctive:

    Always give released versions a date.

    line 35
  3. Distinctive:

    Write for a human reader deciding whether/how to upgrade — clear, past-tense, no internal jargon or bare commit hashes.

    line 37

“Common” is measured: kept by at least 6 in 10 of the 149 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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

changelog

Produces a changelog in the Keep a Changelog 1.x sense: a curated, time-bound record of what changed between released versions, written for humans, not a machine dump of commits. It is episodic — every entry is anchored to a version and a release date.

Pattern (industry: Keep a Changelog 1.x, keepachangelog.com)

  1. Title + intro — an # Changelog H1 and a one-line statement that the file follows Keep a Changelog and Semantic Versioning.
  2. ## [Unreleased] — the top section, accumulating changes not yet released.
  3. Version sections — ## [x.y.z] - YYYY-MM-DD, newest first (reverse-chronological). The date is ISO-8601.
  4. Grouped subsections — within each version, ### headings drawn only from the fixed set, in this order: Added, Changed, Deprecated, Removed, Fixed, Security. Include only the groups that apply.
  5. Link-reference definitions (optional) — at the bottom, [x.y.z]: <url> compare/diff links matching each version header.

Rules that keep it a changelog

  • One entry block per version, not per commit. Curate; summarize the notable user-facing change, don't paste git log.
  • Group same kinds of change together using the six canonical categories — no ad-hoc category names.
  • Latest version on top; ## [Unreleased] above all releases.
  • Follow SemVer: breaking changes bump MAJOR, features MINOR, fixes PATCH.
  • Always give released versions a date; flag removals/Deprecated and Security explicitly so readers can assess upgrade risk.
  • Write for a human reader deciding whether/how to upgrade — clear, past-tense, no internal jargon or bare commit hashes.

MIF frontmatter

type: episodic (a changelog is a time-bound record). Gate every output with mif-validate; the floor is --level 1.

Why machine-readable

A changelog is read as much by agents as by people — a release bot asking "what window does this history cover?", a freshness check asking "when was this last updated?", a dependency walker asking "what does this document?". As plain prose (L1) every one of those needs the markdown parsed and inferred. The MIF layer makes them answerable by reading frontmatter: temporal.validFrom..recordedAt bound the release window, modified dates the last edit, and a typed relationships[] (relates-to) names the tool the log documents. The same file still reads as a human changelog and projects losslessly to JSON-LD and back.

Because a changelog is episodic, L2 is the honest ceiling for this genre: temporal fits, but provenance/citations (L3) would be fabricated — a release history is not an attributable external claim.

The L1 -> L2 climb (two exemplars)

  • templates/good-l1.md — L1 floor: id, type, created + body. A valid changelog, but opaque to a machine consumer.
  • templates/good.md — L2 (highest this genre supports): adds namespace, modified, temporal validity, and a typed relates-to relationship. Validate with mif-validate --level 2.

Author at the highest level the context honestly supports (grade down rather than fabricate). templates/bad.md shows the antipattern: a changelog reduced to ungrouped, undated, unversioned git-log lines — the most common failure.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.