docs(changelog): tighten unreleased notes - #65
Merged
Conversation
Trim the rationale from the Unreleased entries — the reasoning belongs in the PR and commit history, not in a user-facing changelog. Drop the empty Fixed heading, matching the convention 0.8.1 established. Prose is no longer hard-wrapped at 80 columns; .editorconfig sets max_line_length for **.sh only, so markdown lines wrap at render time and reworded sentences stop reflowing whole paragraphs in diffs.
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.
🔗 Ticket
🤔 Background
The
## Unreleasedentries added in #64 carried the reasoning behind each change — benchmark numbers, the mechanics of bashunit's doubles API, the full list of bumped action versions. That detail belongs in the PR and commit history. In a changelog it buries what a reader actually wants: what changed for them.They were also hard-wrapped at 80 columns, which makes diffs noisy — rewording one sentence reflows the whole paragraph.
💡 Goal
Make the Unreleased section scannable, and stop hard-wrapping markdown prose.
🔖 Changes
### Changedentries down to one line each, dropping benchmark figures and per-action version lists.### Addedentry to lead with the flags rather than the motivation.### Fixedheading, matching the convention 0.8.1 established..editorconfigsetsmax_line_lengthfor**.sh(120) only and never for**.md, so long lines passmake lint— confirmed locally.Net: 30 lines to 9, with no information a changelog reader needs removed.
🖼️ Screenshots
BEFORE
AFTER
✅ Verification
make lintclean. Documentation only — no code touched, so the tests and ShellCheck jobs skip via the existing paths filter.