You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
adds a Git note (docs/git-notes/31c168c72351f2885bcf7361b9168cefb454f6dc.txt) of type amend-message which touches up the message of commit 31c168c by replacing the Closes: token with Private-ref: for the reference to https://github.com/stdlib-js/todo/issues/2288. Per the Git style guide, Private-ref: is the token reserved for links to private resources, and stdlib-js/todo is a private tracker. The rest of the commit message is reproduced verbatim (byte-identical), since the amend-message note type replaces the entire message when applied via make apply-git-notes.
Related Issues
Does this pull request have any related issues?
This pull request has the following related issues:
Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.
Verification performed: the note body was diffed byte-for-byte against the original commit message (recovered from the commit's .patch endpoint, since the API strips trailer e-mail addresses; addresses cross-checked against CONTRIBUTORS) — the only difference is Closes: → Private-ref:. The note was applied in a scratch repository using the exact command form from tools/make/lib/git/notes.mk and re-extracted through the front-matter convention used by @stdlib/_tools/changelog/parse-commits; the resulting message is exactly the corrected one. The file format is byte-identical to what the git_note_amend_message.yml workflow would generate.
Generated changelog output is unchanged by this note: the URL-form Closes: reference was already excluded from the "Closed Issues" section (closed_issues.js requires a digit-string ref), so the effect of this change is style-guide conformance of the effective commit message and removal of a malformed mention (.../stdlib/issues/https://github.com/stdlib-js/todo/issues/2288) from the parsed commit model.
Observations for possible follow-ups (out of scope here): eleven 2026 docs:/chore: add Git note … meta-commits also use Closes: with private stdlib-js/todo URLs; three existing note files (7fd86dd7…, 8a0bdab1…, bacbb9b2…) contain a second appended YAML document which the parser splices into the amended message; apply-git-notes exits 0 even when a note's commit hash does not resolve (|| echo), so a typo'd note filename would be a silent permanent no-op; and docs/git-notes/ files have no semantic validation (hash resolvability, front-matter schema, message fidelity) in CI.
Checklist
Please ensure the following tasks are completed before submitting this pull request.
When authoring the changes proposed in this PR, did you use any kind of AI assistance?
Yes
No
If you answered "yes" above, how did you use AI assistance?
Code generation (e.g., when writing an implementation or fixing a bug)
Test/benchmark generation
Documentation (including examples)
Research and understanding
Disclosure
If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".
This PR was written by Claude Code: it researched the repository's Git-notes mechanism and style guide, authored the note file, and verified the result against the changelog tooling.
Reviewer context — distilled working notes for this change:
What the change is. One file: docs/git-notes/31c168c72351f2885bcf7361b9168cefb454f6dc.txt, an amend-message Git note replacing Closes: with Private-ref: for the private stdlib-js/todo reference in commit 31c168c's message, with every other byte of the message preserved.
Why the full message is reproduced.@stdlib/_tools/changelog/parse-commits replaces the entire commit message with the note body (everything after the closing --- of the front matter), so a note containing only the changed trailer would destroy the subject and remaining trailers.
How the original message was recovered. From the commit's .patch endpoint rather than the REST API, because the API strips e-mail addresses from trailers (Reviewed-by: Athan Reines without address). Addresses were cross-checked against CONTRIBUTORS.
Verification performed.
Byte-for-byte diff of note body vs. original message: exactly one changed line (Closes: → Private-ref:).
File format compared byte-for-byte (cmp) against what .github/workflows/git_note_amend_message.yml would emit: identical.
Applied in a scratch repo via the exact git notes add -f -F form used by make apply-git-notes, then run through the real parse-commits extraction: yields exactly the corrected message; note blob SHA matches the committed file (no transformation).
Downstream changelog model compared before/after: "Closed Issues" output unchanged (the URL-form ref was already filtered by the digit-string check in closed_issues.js); the only model change is removal of a malformed mention URL (…/stdlib/issues/https://github.com/stdlib-js/todo/…).
Edge cases exercised against the parser (CRLF, extra ---, |, ^---^, BOM, missing trailing newline, bad/missing type): the file is on the safe side of all of them.
.editorconfig rules and filename lint verified to pass; no license header, matching all 84 existing notes.
Deliberate scope decisions.
Ref: (a public stdlib commit-comment URL) and PR-URL: were left untouched — Ref: is the correct token for public resources; only the Closes: line referenced a private resource.
Notes referencing stdlib-js/metr-issue-tracker with Closes: were left alone — that tracker is public.
Out-of-scope observations (11 older meta-commits with the same Closes:-on-private-URL pattern, three note files with appended second YAML documents that splice into changelog messages, apply-git-notes swallowing failures for unresolvable hashes, no semantic CI validation for docs/git-notes/) are listed in the PR description's "Other" section as possible follow-ups rather than widening this PR.
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
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.
Closes: https://github.com/stdlib-js/todo/issues/2295
Description
This pull request:
docs/git-notes/31c168c72351f2885bcf7361b9168cefb454f6dc.txt) of typeamend-messagewhich touches up the message of commit31c168cby replacing theCloses:token withPrivate-ref:for the reference tohttps://github.com/stdlib-js/todo/issues/2288. Per the Git style guide,Private-ref:is the token reserved for links to private resources, andstdlib-js/todois a private tracker. The rest of the commit message is reproduced verbatim (byte-identical), since theamend-messagenote type replaces the entire message when applied viamake apply-git-notes.Related Issues
This pull request has the following related issues:
Questions
No.
Other
.patchendpoint, since the API strips trailer e-mail addresses; addresses cross-checked againstCONTRIBUTORS) — the only difference isCloses:→Private-ref:. The note was applied in a scratch repository using the exact command form fromtools/make/lib/git/notes.mkand re-extracted through the front-matter convention used by@stdlib/_tools/changelog/parse-commits; the resulting message is exactly the corrected one. The file format is byte-identical to what thegit_note_amend_message.ymlworkflow would generate.Closes:reference was already excluded from the "Closed Issues" section (closed_issues.jsrequires a digit-string ref), so the effect of this change is style-guide conformance of the effective commit message and removal of a malformed mention (.../stdlib/issues/https://github.com/stdlib-js/todo/issues/2288) from the parsed commit model.docs:/chore: add Git note …meta-commits also useCloses:with privatestdlib-js/todoURLs; three existing note files (7fd86dd7…,8a0bdab1…,bacbb9b2…) contain a second appended YAML document which the parser splices into the amended message;apply-git-notesexits 0 even when a note's commit hash does not resolve (|| echo), so a typo'd note filename would be a silent permanent no-op; anddocs/git-notes/files have no semantic validation (hash resolvability, front-matter schema, message fidelity) in CI.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written by Claude Code: it researched the repository's Git-notes mechanism and style guide, authored the note file, and verified the result against the changelog tooling.
@stdlib-js/reviewers
🤖 Generated with Claude Code
https://claude.ai/code/session_01Mv7vcSu2fiuMLniVQxBV1Z
Generated by Claude Code