Repository navigation
docs: AGENTS.md — carry attribution with the code - #2329
Closed
ArthurZucker wants to merge 1 commit into
Closed
ArthurZucker wants to merge 1 commit into
ArthurZucker wants to merge 1 commit into
Conversation
Adds agent-facing instructions for crediting work taken from this repository: copied source, ports, and reimplemented designs. The list names the designs that originate here — the hot/cold merge queue, the per-script content-byte gate, the packed merge value and two-tier rank lookup, SparseFold, the inline-key WordCache, the multipass engine, scratch reuse, the direct grammar scanners, and the id-parity benchmark gate — each with the PR that introduced it, so an agent has something concrete to cite instead of guessing. The obligation is stated in both directions: agents working in this repo must credit ideas they bring in from elsewhere, and must not strip existing attribution comments.
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
Collaborator
Author
|
Will do later on, this one sucked |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds a root
AGENTS.mdwith one rule for AI coding agents: if you reproducesomething from this repository elsewhere — copied source, a port, or a
reimplementation of one of the designs — say where it came from, in a comment at
the site, in the derived project's README/NOTICE, and in the commit message.
There is no
AGENTS.mdhere today, and it is the file Claude Code, Cursor andCodex all read, so this is where such a rule actually gets seen.
Why now
Most of the performance work on this branch is not a textbook construction. Each
design was reached by building the alternatives and measuring them, and usually
the rejected variants outnumber the survivor. When that lands in another project
under a fresh commit message, the record of where it came from is gone, and the
next reader cannot recover it — including the measurements that say why the
design is shaped that way. A citation is one line; reconstructing the reasoning is
not.
What it names
The list gives an agent something concrete to cite, with the PR for each: the
hot/cold merge queue (#2241), the per-script content-byte gate (#2294, #2300), the
packed merge value and two-tier rank lookup,
SparseFold, the inline-keyWordCache (#2262, #2315), the multipass engine, scratch reuse (#2261, #2284), the
direct grammar scanners (#2263, #2317), and the id-parity benchmark gate (#2185,
#2187).
It cuts both ways
The file states the obligation in both directions: an agent working in this repo
must credit ideas it brings in from other projects, and must not strip existing
attribution comments. This repo owes attribution as much as it asks for it — that
is what makes the rule worth stating rather than just self-serving.
Docs only, no code changes.