Gestion du CHANGELOG

VérifiéSûr

Auditez, rédigez ou mettez à jour CHANGELOG.md selon Keep a Changelog 1.1.0. Détecte les configurations automatiques et applique SemVer.

Spar Skills Guide Bot
DocumentationIntermédiaire
22/07/2026
Claude CodeCursorCodex
#changelog#keep-a-changelog#semver#release-notes#git-history

Recommandé pour

Synthèse automatique

Audite, rédige ou met à jour un CHANGELOG.md selon la norme Keep a Changelog 1.1.0, en sélectionnant les changements réellement visibles pour les utilisateurs et en appliquant semver (ou PVP pour Haskell).

Points forts

  • Filtre explicite entre changements visibles par les consommateurs et bruit interne (refactors, tests, CI, typos)
  • Détecte les outils de changelog automatisés (changesets, release-please, git-cliff, semantic-release, towncrier) et s'efface au lieu de les concurrencer
  • Gère un mode pré-première-version qui regroupe tout sous un seul bloc Added, avec la transition expliquée pour la première release
  • Rappelle les invariants de forme : section [Unreleased], ordre des rubriques, liens de comparaison, versions publiées immuables

Limites

  • Ne couvre pas la découpe d'une release : pas de tag ni de modification de fichier de version
  • Suppose un historique git exploitable ; la qualité des entrées dépend des commits et PR disponibles
  • S'arrête par défaut si un outil de gestion automatique est détecté, sauf demande explicite de l'utilisateur
Quand l'utiliser

À utiliser pour créer un CHANGELOG.md, auditer les commits depuis la dernière version, ou vérifier que la section [Unreleased] reflète bien les changements perçus par les utilisateurs.

Quand l'éviter

À éviter si le projet gère déjà son changelog via un outil automatisé, ou si la tâche consiste à taguer et publier une version.

Analyse de sécurité

Sûr
Score qualité88/100

The skill is documentation-only guidance for maintaining CHANGELOG.md. It declares no tools, and the only commands it references are read-only git inspections (git status, git diff, git log, git tag) used as evidence. There is no file deletion, no network fetch/execution (curl|sh), no credential or secret handling, no obfuscated payloads, and no attempt to bypass safety controls. Risk is essentially that of a text-editing convention document.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Bootstrap a changelog
Create a CHANGELOG.md for this repository following Keep a Changelog. It has never been released, so treat the current feature set as the inaugural release.
Audit Unreleased against commits
Review the commits since v1.4.0 and tell me which user-visible changes are missing from the [Unreleased] section of CHANGELOG.md, then update it.
Fix misplaced entry
This entry was merged after the v2.0.0 tag but landed in the released section — move it back to [Unreleased] and tidy the section order.

name: changelog description: Audit, write, or update CHANGELOG.md following Keep a Changelog 1.1.0. Use when creating a CHANGELOG, or reviewing commits to ensure Unreleased reflects user-visible changes. Defers to auto-managed setups (changesets, release-please, git-cliff, semantic-release, towncrier) and applies semver 2.0.0 — or Haskell PVP for Haskell projects.

Changelog

References: https://keepachangelog.com/en/1.1.0/, https://semver.org/, https://pvp.haskell.org/.

This skill maintains a hand-curated KAC. It detects auto-managed setups and steps aside; it never proposes adopting tooling. Cutting a release (tagging, version-file edits) is out of scope — bootstrap and review-against-commits only.

Defer to auto-tooling

If any are present the changelog is auto-managed — surface the detection and stop unless the user overrides:

  • .changeset/ — changesets
  • .release-please-manifest.json / release-please-config.json — release-please
  • cliff.toml / .cliff.toml — git-cliff
  • package.json "release" / "semantic-release", or .releaserc* / release.config.* — semantic-release
  • pyproject.toml [tool.towncrier], or newsfragments/ — towncrier

Treat any clearly auto-managed CHANGELOG the same way.

What to include

Entries describe changes visible to consumers of the deliverable — users of the library / CLI / service, not contributors to the repo.

Include: public API changes (additions, removals, renames, signatures), observable behavior changes (output, errors, defaults), user-facing bug fixes, perceptible performance changes, security fixes, breaking deprecations, and supported-platform / runtime / dependency changes users must adapt to.

Skip: typos, comment-only changes, internal refactors, test changes, build/CI tweaks, dependency bumps users don't perceive, doc fixes (unless docs are the deliverable), and fixes for bugs no released version exhibited.

The test: "would a user of this project notice or care?" If no, skip.

Ruling-out heuristic: if removing the entry would leave the eventual release notes equally accurate, it doesn't belong. This catches both the user-impact failures above and pre-release deltas-of-deltas (see Pre-first-release mode).

Pre-first-release mode

Detect: git tag is empty AND no version sections appear below [Unreleased]. The project has never shipped — surface this explicitly and switch behavior.

Pre-first-release entries are not deltas; they're the inaugural feature set. Collapse to a single ### Added bucket — every change is "added" from a future user's perspective. Don't author Changed / Removed / Fixed / Deprecated / Security entries: they describe deltas no user will witness. Fold runtime, dependency, or platform requirements into the matching Added line (e.g. "CLI tool, requires Node.js 20+" — not a separate Changed line).

Pivot when the first release lands (v0.1.0, or PVP equivalent): subsequent [Unreleased] sections split by bucket because they're now deltas against a shipped artifact. Spell this out at bootstrap so the future cutover is expected.

Format invariants

  • ## [Unreleased] at the top; releases below as ## [X.Y.Z] - YYYY-MM-DD, newest first.
  • Section order (post-first-release): Added → Changed → Deprecated → Removed → Fixed → Security. Omit empty sections unless the file already keeps them. Don't pre-seed empty subsection headers — add a header only when its first entry lands. Pre-first-release uses ### Added only.
  • Comparison links at the bottom ([X.Y.Z]: https://.../compare/...).
  • Released versions are immutable. If a PR merged after its target tag, move the entry from the released section back to [Unreleased] rather than editing the released section.

Versioning

Default: semver 2.0.0 — MAJOR breaking, MINOR additions, PATCH fixes.

Haskell (any of *.cabal, cabal.project, stack.yaml, package.yaml present): PVP A.B.C.D. Both A and B together form the major version — a bump in either means breaking change. C is for API additions. D is maintainer-defined, typically non-API patches. The leading A is the "epoch" — discretionary, used for major directional shifts and documented in the PVP FAQ as a recognized convention.

Bootstrap names the scheme in the seeded header so future review classifications stay consistent. The skill does not perform bumps.

Evidence

Source entries from the repository, not invention:

  • git status --short, git diff, git diff --cached — pending changes.
  • git log --oneline <last-tag>..HEAD — commits since the last release.
  • Existing CHANGELOG.md headings and link style.

If a change is real and user-visible but its KAC category isn't clear from the diff, mark TBD (owner needed) instead of guessing.

Modes

Bootstrap (no CHANGELOG.md): seed a minimal KAC 1.1.0 skeleton — ## [Unreleased], a header link to keepachangelog.com, and a note naming the versioning scheme (semver or PVP). No empty subsection headers under [Unreleased]. If pre-first-release (no git tags), note in the seed that entries collect under a single ### Added until the first release cuts. Optionally backfill ## [X.Y.Z] sections from existing git tags — ask first, never unsolicited. Do not propose adopting tooling.

Review (CHANGELOG exists): walk commits since the last release tag (or since the last [Unreleased] update), apply the user-impact filter and the ruling-out heuristic, classify each kept change, and update [Unreleased]. Pre-first-release: single ### Added bucket, fold runtime/dependency requirements into their feature lines. Post-first-release: classify into one of the six KAC sections. Used both during work as discoveries land and at release-prep time.

Procedure

  1. Detect auto-tooling. If present, surface and stop unless overridden.
  2. Determine versioning scheme (PVP if Haskell, else semver).
  3. Detect pre-first-release: git tag empty AND no version sections below [Unreleased]. Surface the state; it changes step 6.
  4. Pick the mode: bootstrap / review.
  5. Walk evidence; apply the user-impact filter and ruling-out heuristic; drop anything that fails.
  6. Map kept changes:
    • Pre-first-release: single ### Added bucket; fold dependency / platform requirements into their feature line.
    • Post-first-release: classify into Added / Changed / Deprecated / Removed / Fixed / Security; create section headers only when populated.
  7. Verify: section order preserved, no empty subsection headers, no released-version mutation, no fabricated entries, no skipped-category items present.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/changelog-management-mrwakgav/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/changelog-management-mrwakgav' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/changelog-management-mrwakgav/download' --output '.skill-downloads/changelog-management-mrwakgav/SKILL.md.part' && mv '.skill-downloads/changelog-management-mrwakgav/SKILL.md.part' '.skill-downloads/changelog-management-mrwakgav/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/changelog-management-mrwakgav/SKILL.md' && test -s '.skill-downloads/changelog-management-mrwakgav/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/changelog' && cp -R '.skill-downloads/changelog-management-mrwakgav' '.claude/skills/changelog'

Cursor
test -f '.skill-downloads/changelog-management-mrwakgav/SKILL.md' && test -s '.skill-downloads/changelog-management-mrwakgav/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/changelog' && cp -R '.skill-downloads/changelog-management-mrwakgav' '.cursor/skills/changelog'

Codex
test -f '.skill-downloads/changelog-management-mrwakgav/SKILL.md' && test -s '.skill-downloads/changelog-management-mrwakgav/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/changelog' && cp -R '.skill-downloads/changelog-management-mrwakgav' '.agents/skills/changelog'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/changelog-management-mrwakgav'

openskills read 'changelog-management-mrwakgav'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/changelog-management-mrwakgav/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires