Skip to content

docs: add Git note - #14516

Merged
kgryte merged 1 commit into
developfrom
claude/dazzling-pascal-12fz1d
Aug 22, 2026
Merged

kgryte merged 1 commit into
developfrom
claude/dazzling-pascal-12fz1d

Conversation

@Planeshifter

@Planeshifter Planeshifter commented Aug 22, 2026 •

Copy link
Copy Markdown
Member

Closes: https://github.com/stdlib-js/todo/issues/2295

Description

What is the purpose of this pull request?

This pull request:

  • 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:

Questions

Any questions for reviewers of this pull request?

No.

Other

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.

AI Assistance

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.


@stdlib-js/reviewers

🤖 Generated with Claude Code

https://claude.ai/code/session_01Mv7vcSu2fiuMLniVQxBV1Z


Generated by Claude Code

Private-ref: https://github.com/stdlib-js/todo/issues/2295
Assisted-by: Claude <noreply@anthropic.com>

Copy link
Copy Markdown
Member Author

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.

Open questions. None.


Generated by Claude Code

@kgryte
kgryte marked this pull request as ready for review August 22, 2026 03:41
@kgryte
kgryte requested a review from a team August 22, 2026 03:41
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Aug 22, 2026
@kgryte kgryte changed the title docs: add Git note for commit 31c168c72351f2885bcf7361b9168cefb454f6dc docs: add Git note Aug 22, 2026
@kgryte
kgryte merged commit 8981150 into develop Aug 22, 2026
35 checks passed
@kgryte
kgryte deleted the claude/dazzling-pascal-12fz1d branch August 22, 2026 03:42
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Aug 22, 2026
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.

4 participants