Skip to content

docs: groom the unreleased changelog ahead of the next release - #322

Draft
kkozik-amplify wants to merge 1 commit into
mainfrom
docs/changelog-grooming
Draft

docs: groom the unreleased changelog ahead of the next release#322
kkozik-amplify wants to merge 1 commit into
mainfrom
docs/changelog-grooming

Conversation

@kkozik-amplify

Copy link
Copy Markdown
Collaborator

Why

Two outside contributors sent the five fixes currently sitting in Unreleased, and the changelog didn't say so. This repo has credited contributors by name since at least 6.x — dropping it now would be a poor look on a release that is largely their work.

Opened as a draft as a holding branch for changelog grooming before the next release, so anything else we want to tidy can land here rather than as a scatter of one-line PRs.

What

Contributor credit

Follows the existing convention exactly — Thanks, @user before a single trailing link (see the 7.2.1 and 7.2.0 sections):

Entry Credit PR
Empty heredoc @livingstaccato #312
Negative integer literals @livingstaccato #311
strip_string_quotes — expression interiors @livingstaccato #313
strip_string_quotes — escape sequences @livingstaccato #313
CRLF line endings @agu2347 #317
Heredoc trailing whitespace @agu2347 #318

@livingstaccato also reported #307#310, so the credit covers both halves of that work.

Link style

The Unreleased entries pointed at issue numbers; every other entry in the file points at the PR. The file is 67 /pull/ links to 22 /issues/, and all 20 existing Thanks lines use /pull/. Switched the seven Unreleased entries to match, including the py.typed line (#298 → its PR #299).

Note the two strip_string_quotes entries now both point at #313. That's correct — one PR fixed two reported issues, and they're worth listing as separate behaviour changes.

Deliberately not done

Unrelated thing worth a look

All six issues fixed by these PRs — #307, #308, #309, #310, #315, #316 — are still open, even though each PR carried a recognised Fixes #N (the API reports them under closingIssuesReferences) and all merged into main over 12 hours ago. Auto-close appears not to have fired. Not something this PR touches, but they probably want closing by hand.

Test plan

Two outside contributors sent the five fixes sitting in Unreleased and
the changelog did not say so. This repo has credited contributors by name
since at least 6.x; the release is largely their work.

Follows the existing convention -- `Thanks, @user` before a single
trailing link. @livingstaccato also reported #307-#310, so the credit
covers reporting and fixing both.

Also switches the Unreleased links from issue numbers to PR numbers to
match the rest of the file: 67 /pull/ links against 22 /issues/, and all
20 existing Thanks lines use /pull/. The two strip_string_quotes entries
both point at #313 because one PR fixed two reported issues, which is
worth listing as two behaviour changes.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.

1 participant