Skip to content

docs #459: adopt strict Keep a Changelog 1.1.0 format#470

Merged
vita-kotacka merged 1 commit into
developfrom
issues/459-strict-keepachangelog
Jun 18, 2026
Merged

docs #459: adopt strict Keep a Changelog 1.1.0 format#470
vita-kotacka merged 1 commit into
developfrom
issues/459-strict-keepachangelog

Conversation

@vita-kotacka

Copy link
Copy Markdown
Member

Description

Adopt the strict Keep a Changelog 1.1.0 format in java-core, re-aligning the changelog conventions agreed in the parent epic wultra/tasklist#986.

  • CHANGELOG.md:
    • Canonical header mentioning both Keep a Changelog and Semantic Versioning.
    • ## 2.2.0 (TBA)## [Unreleased] (bracketed, linkable).
    • Added a reference-style [unreleased] compare link (2.1.0...HEAD).
  • .github/copilot-instructions.md: updated the Changelog section to document the strict convention (Unreleased section, release-time rename + fresh Unreleased, linkable version references, canonical header).

Motivation and Context

The previous convention (## X.Y.Z (TBA), no Semantic Versioning mention, no linkable versions) did not strictly follow Keep a Changelog 1.1.0. This PR brings java-core into strict compliance.

Closes

Closes #459

Use the canonical Keep a Changelog header (mentioning Semantic Versioning),
the [Unreleased] section, and linkable version references. Update the Copilot
changelog instructions to document the strict convention.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@vita-kotacka vita-kotacka requested a review from romanstrobl June 17, 2026 13:31

@romanstrobl romanstrobl left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks!

@vita-kotacka vita-kotacka merged commit cf8f9e4 into develop Jun 18, 2026
2 checks passed
@vita-kotacka vita-kotacka deleted the issues/459-strict-keepachangelog branch June 18, 2026 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consolidate CHANGELOG.md and add Copilot changelog instructions

2 participants