Skip to content

Exclude documentation-only changes from the changelog - #131

Merged
sir-sigurd merged 1 commit into
mainfrom
changelog-no-docs-entries
Nov 3, 2026
Merged

sir-sigurd merged 1 commit into
mainfrom
changelog-no-docs-entries

Conversation

@sir-sigurd

Copy link
Copy Markdown
Member

The need

The changelog's Policy asks for documentation entries: "documentation" is in its Comprehensiveness list, and a separate line says how to write entries for documentation PRs. Both arrived in #88, and practice has not followed them since: the last documentation-only change with an entry is #92, merged the same day; #106 and #122 went in without one, and #123 dropped the entry it had drafted. The changelog's readers track what the module does, and a documentation line tells them nothing about that.

What changed

The Policy stops asking for documentation entries: Comprehensiveness lists features, fixes and breaking changes and says documentation-only changes get no entry, and the line on writing entries for documentation PRs is gone. Released history is left as it is, so the 1.4.0 Documentation section stays. This PR is documentation-only and so carries no entry of its own.

Verification

npm ci && npx --no-install markdownlint-cli2, the commands of the CI markdownlint job: 0 issues in 6 files. No test reaches policy text.

Links

No issue, spec or sibling pull request.

Risk and rollback

An author could read a change that touches both documentation and module behaviour as documentation-only and skip its entry; the wording limits the exclusion to changes that are documentation only. Rollback is reverting this commit.

The optionality note

Closes no door: documentation entries can come back with a one-line policy change, and the 1.4.0 Documentation section keeps the record of the ones already released.

🤖 Generated with Claude Code

The changelog tracks module behaviour for its users, and doc-only
changes have gone in without entries since #92.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 3, 2026 01:52
@greptile-apps

greptile-apps Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] This policy-only change appears safe to merge.

Reviews (1) · Last reviewed commit: "Exclude documentation-only changes from ..." · Reviewed by Greptile

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues are reported for the changelog policy update excluding documentation-only changes.

No open issues 🎉

What changed in this PR

Updates the changelog policy to focus on module changes rather than documentation-only updates, aligning the written policy with recent practice.

Changes:

  • Explicitly excludes documentation-only changes from changelog entries.
  • Removes the guidance for writing documentation PR entries.
  • Preserves released history, including the 1.4.0 Documentation section.
File Description
CHANGELOG.md Revises the policy to exclude documentation-only changes while retaining existing release entries.

Review effort: Balanced

@sir-sigurd
sir-sigurd merged commit c40936b into main Nov 3, 2026
12 checks passed
@sir-sigurd
sir-sigurd deleted the changelog-no-docs-entries branch November 3, 2026 02:11
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.

2 participants