Repository navigation
Exclude documentation-only changes from the changelog - #131
Merged
Merged
Conversation
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>
[Low impact] This policy-only change appears safe to merge. Reviews (1) · Last reviewed commit: "Exclude documentation-only changes from ..." · Reviewed by Greptile |
There was a problem hiding this comment.
🟢 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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