Skip to content
Agent Skills Catalog

Keep a Changelog (v1.1.0) Reference

keywords plugin keywords, from plugin.json
  • readme
  • changelog
  • technical-writing
  • git-recap
plugin derived
Repository Authoringrepo-authoring
conformance derived from plugin.json $schema
Targets Agent Plugins 1.0.0.
source derived
plugins/repo-authoring/skills/changelog-manager/references/keep-a-changelog.md

A plugin-level reference of repo-authoring. This location is not defined by Agent Plugins §6.1; the title below is this file's own H1, extracted, not composed.

A changelog is a file that contains a curated, chronologically-ordered list of notable changes for each version of a project.

Guiding Principles

  1. Changelogs are for humans, not machines. Write for people, not parsing algorithms.
  2. There should be an entry for every single version.
  3. The same types of changes should be grouped.
  4. Versions and releases should be linkable.
  5. The latest version should come first.
  6. The release date of each version should be displayed.
  7. Mention whether you adhere to Semantic Versioning.

Types of Changes

  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
  • Removed for now removed features.
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.

Format Example

# Changelog


All notable changes to this project will be documented in this file.


The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [Unreleased]


### Added
- German translation.


## [1.0.0] - 2017-06-20


### Added
- New visual identity.


### Fixed
- Swedish title translation.