Skip to content

docs: enforce changelog release-note quality (#235) - #253

Merged
codeforester merged 1 commit into
mainfrom
documentation/235-20260828-v1-0-define-and-enforce-changelog-and-release-note-quality
Aug 28, 2026
Merged

docs: enforce changelog release-note quality (#235)#253
codeforester merged 1 commit into
mainfrom
documentation/235-20260828-v1-0-define-and-enforce-changelog-and-release-note-quality

Conversation

@codeforester

Copy link
Copy Markdown
Contributor

Closes #235.

Summary

  • enforce Keep a Changelog version/date/order and release-link rules
  • reject duplicate bullets/categories and accidental internal planning text
  • repair the duplicate Unreleased entry and add release comparison links
  • run changelog validation in tests, docs, and package workflows
  • document the contributor/release-note policy

Validation

  • uv run --extra dev --extra quality pytest tests/test_validate_changelog.py tests/test_validate_docs.py
  • uv run --extra quality ruff check scripts/validate_changelog.py tests/test_validate_changelog.py
  • uv run --extra quality ruff format --check scripts/validate_changelog.py tests/test_validate_changelog.py

@codeforester codeforester added the documentation Documentation improvements label Aug 28, 2026
@codeforester
codeforester merged commit 5bb8cc7 into main Aug 28, 2026
91 of 92 checks passed
@codeforester
codeforester deleted the documentation/235-20260828-v1-0-define-and-enforce-changelog-and-release-note-quality branch August 28, 2026 06:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[v1.0] Define and enforce changelog and release-note quality

1 participant