Skip to content

docs: add Git note - #14513

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

kgryte merged 1 commit into
developfrom
claude/dazzling-pascal-1byx91

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Resolves stdlib-js/todo#2814.

Description

What is the purpose of this pull request?

This pull request:

  • adds a Git note (docs/git-notes/fb7d2761ff470f4caf7bf662dde9f112349dde3f.txt) of type amend-message which amends the commit message of fb7d276 to correct a typo in the package name: blas/ext/base/ndarray/ginddex-of-truthy → blas/ext/base/ndarray/gindex-of-truthy. The rest of the commit message (including the BREAKING CHANGE paragraph and the PR-URL, Reviewed-by, and Closes trailers) is reproduced verbatim.

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

  • stdlib-js/todo#2814

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.

  • The corrected package name was verified against the files actually modified by the target commit (lib/node_modules/@stdlib/blas/ext/base/ndarray/gindex-of-truthy/).
  • The note file follows the exact format produced by the git_note_amend_message workflow, and applying it via the apply-git-notes rule in tools/make/lib/git/notes.mk (git notes add -f -F <file> <hash>) was verified locally; the amended message contains no occurrence of inddex and is otherwise byte-for-byte identical to the original.
  • The note parses cleanly under the amend-message handling in @stdlib/_tools/changelog/parse-commits, so generated changelogs will pick up the corrected package name.

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

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 authored entirely by Claude Code as an automated task: it researched the repository's Git-note conventions, generated the note file, and verified it against the repository's tooling.


@stdlib-js/reviewers

🤖 Generated with Claude Code

https://claude.ai/code/session_01D8V3L1W9tj2MayvtxHstAw


Generated by Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01D8V3L1W9tj2MayvtxHstAw

Copy link
Copy Markdown
Member Author

Reviewer context — automated task summary

This PR was produced by an automated issue-resolution run for stdlib-js/todo#2814 ("Add Git note": "inddex should be index in the commit message" of fb7d276). Distilled decision log:

Approach

  • Established the repo convention from .github/workflows/git_note_amend_message.yml and tools/make/lib/git/notes.mk: an amend-message note is docs/git-notes/<hash>.txt with type: amend-message front matter followed by the full corrected commit message; the commit message format docs: add Git note for commit <hash> comes from the workflow itself.
  • The only occurrence of inddex in the original message is in the subject's package name ginddex-of-truthy; the correction to gindex-of-truthy was verified against the package directory the commit actually modified.

Verification performed

  • Applied the note locally with the exact command CI uses (git notes add -f -F <file> <hash>); the amended message contains zero occurrences of inddex and is byte-for-byte identical to the original apart from the typo fix (diff-verified, trailers preserved).
  • Confirmed the note parses under the amend-message case in @stdlib/_tools/changelog/parse-commits (front-matter extraction + message replacement).
  • Format checks against existing amend-message notes: LF endings, trailing newline, no trailing whitespace, 40-hex filename, mode 100644. No lint target covers docs/git-notes/*.txt (license-header lint excludes plain .txt; filename lint passes by construction).
  • Independent review passes (correctness, scope, conventions, robustness, verification-by-reproduction) reported zero blockers and zero majors.

Open observations (logged, intentionally not actioned here — out of scope for the issue)

  • Pre-existing hardening opportunities in surrounding tooling: apply-git-notes does not validate that a note's basename is a full hex SHA; git notes add -f silently clobbers an existing note; no CI lint validates note-file structure or hash reachability for hand-authored notes. These affect the infrastructure generally, not this file.

This PR is intentionally left in draft for human review.


Generated by Claude Code

@kgryte
kgryte marked this pull request as ready for review August 22, 2026 02:57
@kgryte
kgryte requested a review from a team August 22, 2026 02:57
@kgryte kgryte changed the title docs: add Git note for commit fb7d2761ff470f4caf7bf662dde9f112349dde3f docs: add Git note Aug 22, 2026
@kgryte
kgryte merged commit d1bfd8a into develop Aug 22, 2026
15 checks passed
@kgryte
kgryte deleted the claude/dazzling-pascal-1byx91 branch August 22, 2026 03:12
@stdlib-bot stdlib-bot added Needs Review A pull request which needs code review. and removed Needs Review A pull request which needs code review. labels 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