Skip to content

Instantly share code, notes, and snippets.

View DervishD's full-sized avatar

Raúl Núñez de Arenas Coronado DervishD

View GitHub Profile
@DervishD
DervishD / CHANGELOG.md
Last active January 5, 2026 15:53
DervishD's changelog specification

DervishD changelog specification 2026-01-05

This is a specification for a project's CHANGELOG.md file with a format inspired by Keep a Changelog version 1.1.0, but customized, with different styling and wording.

The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in RFC 2119.

The first sentence in the file SHOULD be All notable changes to this project will be documented in this file., and if the project adheres to a versioning specification, it SHOULD be specified after that.

After that, the file MUST contain a sequence of project release entries, ordered from most recent to oldest.