manifesto.md

Bundle 6 documents

Release Hygiene

Versions, commits, changelogs, licences and citations that mean the same thing to every tool.

  1. 1Semantic Versioning

    A version number of the form major.minor.patch and the rules for when each part increments, so dependency declarations mean the same thing to everyone.

    v2.0.0 in use here
  2. 2Conventional Commits

    A lightweight convention on top of commit messages, type, scope and description, that machines and people can read and that maps onto semantic versions.

    v1.0.0 in use here
  3. 3Keep a Changelog

    A format for a changelog file that people can read, one entry per version, grouped by the kind of change, newest first.

    v1.1.0 in use here
  4. 4REUSE Specification

    A standardised way to declare copyright and licensing for every file in a project, using SPDX identifiers in comment headers, a LICENSES directory and REUSE.toml.

  5. 5System Package Data Exchange

    An open standard data model and serialisations for communicating bill-of-materials information about software, including licensing, security, build, AI and dataset metadata.

    v3.0.1 in use here
  6. 6Citation File Format

    A CITATION.cff file in the root of a repository that gives human- and machine-readable citation metadata for software or a dataset, in YAML.

    v1.2.0 in use here

Other bundles