Skip to content

docs: add "reference package(s)" section to PR template - #16286

Open
batpigandme wants to merge 1 commit into
stdlib-js:developfrom
batpigandme:pr-related-packages
Open

batpigandme wants to merge 1 commit into
stdlib-js:developfrom
batpigandme:pr-related-packages

Conversation

@batpigandme

@batpigandme batpigandme commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • Adds a section to the PR template to put in reference packages used in the PR.
  • Inspiration taken from @anandkaranubc's The Codebase is the Prompt.
  • Aim: Since choosing the reference is the thing tooling can't decide , capture some of the tacit layer/knowledge of patterns in the codebase and how they relate.

Questions

Any questions for reviewers of this pull request?

Following the two examples from @anandkaranubc's post (quoted, below), my examples request tying the packages referenced to the capacity in which they're used:

Ok, considering `blas/ext/base/gxmy` as the closest reference
implementation, we need to refactor everything in
`blas/ext/base/gxdy`.

The difference is mostly implementation, and some other things
you will figure out when comparing.

But as far as structure goes, `blas/ext/base/gxmy` is the way
to go.

“When I point an LLM at blas/ext/base/gxmy and ask for blas/ext/base/gxdy, I am not asking the model to invent a package. I am asking it to compare two related operations and apply an existing pattern. The specification is not in a document. It is in the sibling package, sitting on disk, already reviewed, already merged, and already known to work.”

Tying each reference to the capacity in which it was used is a heavier lift for contributors than a bare list. Worth it?

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

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.".

Drafted the template section in conversation with Claude; the proposal, framing, and final wording are mine (embarrassing grammar fixes courtesy of Claude).


@stdlib-js/reviewers

@batpigandme
batpigandme requested a review from a team October 21, 2026 16:40
@batpigandme

batpigandme commented Oct 21, 2026 •

Copy link
Copy Markdown
Member Author

@kgryte, CI failures are expected as I followed the format of the existing PR template (no license header, no H1).

Errors with Good First PR (Process completed with exit code 5.), and Contributing Guidelines (401 error) appear to be in the workflows themselves.

@batpigandme batpigandme added the Documentation Improvements, additions, or changes to documentation. label Oct 21, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant