Skip to content

Changelog Guide

This guide explains how to read the project changelog and version numbers. It targets contributors and users upgrading between releases.

Table of contents

Semantic versioning

@lapidist/design-lint follows semver: MAJOR.MINOR.PATCH.

  • MAJOR – incompatible API changes
  • MINOR – new functionality in a backward-compatible manner
  • PATCH – backward-compatible bug fixes

Conventional Commits

Commit messages use the Conventional Commits format to generate changelog entries automatically. Example: feat(rules): add opacity rule.

Changesets

Changesets describe pending releases. Each changeset file indicates the semver bump and a summary of the change. During release, the changelog is updated based on these files. See AGENTS.md for the expected format.

See also

Released under the MIT License.