Add a document
One YAML file in manifestos/, by pull request. Public documents only.
# manifestos/<slug>.yaml
name: Keep a Changelog
kind: specification # manifesto | specification | principles | convention
line: One sentence saying what the document is for, under 240 characters.
canonical: https://keepachangelog.com/en/1.1.0/
repo: https://github.com/olivierlacan/keep-a-changelog
version: "1.1.0" # the version this page was read against
status_of_text: stable # draft | stable | historical
license: MIT # licence of the text, when stated
maintainer: Olivier Lacan
first_published: 2014
listing: listed # maintainers set claimed in their own PR
tenets_label: Guiding principles
tenets:
- Changelogs are for humans, not machines.
- There should be an entry for every single version.
related: [semver, conventional-commits] Rules
- The tenets are the document's own headings or principles, quoted or closely paraphrased, never our commentary. Up to twenty.
- The canonical URL is the author's. Mirrors and summaries are not accepted as canonical.
- No logos. Names only.
- Documents the directory lists without the author asking get an issue on the author's repository, or an email where the project asks for that, saying the listing exists and how to claim or remove it. Removal on request, no questions.
- Claiming: the maintainer opens or approves the pull request that sets
listing: claimed, or replies yes on the listing issue. A reaction is not a claim. Claimed cards are marked on the index; unclaimed ones carry no tag. - Bundles: a file in
bundles/names documents commonly adopted together (name,line,membersas slugs). Propose one the same way.
The repository has issue templates for both: add or claim a listing.