Skip to content

Commit 4621d6c

Browse files
committed
docs(agents): require AI attribution on agent-assisted issues
Adopts the kernel's Assisted-by: convention (https://docs.kernel.org/process/coding-assistants.html) plus an ai-assisted label, so a reader can tell at a glance which findings came from an agent and which model produced them. Three details the format invites getting wrong, spelled out because both were live here: the brackets in AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2] mark optionality and are not typed; tools are named analysis utilities that produced evidence in the body, so an ad-hoc repro script does not qualify and most issues carry none; and a bracketed context-window suffix has to come off the model id, since claude-opus-5[1m] would read as the tool syntax. Also carries over the two rules that make the convention mean something. Agents must not add Signed-off-by anywhere — only a human can certify the DCO. And an agent-filed issue must say what it could not do: whether the repro was run, whether a fix was built or tested, what is still unverified. A report that reads as verified but is not costs a maintainer more than no report. Applied retroactively to #120-#131. Assisted-by: Claude:claude-opus-5
1 parent 9f23169 commit 4621d6c

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ tinydantic — a Pydantic v2 ODM for TinyDB. `TinydanticModel` subclasses are py
3333
- When a review turns up something not already tracked, open an issue for it. Re-verify the finding against the current tree first, and record the evidence in the body: what you ran, at which commit, on what date. A finding that no longer reproduces is not filed.
3434
- Every issue carries a type label (`bug`, `enhancement`, `documentation`) plus a topic label where one fits (`performance`, `api-design`, `polish`). Priority, size, and status live on the [project board](https://github.com/orgs/tinydantic/projects/1), not in labels. Milestones name the release the work is intended for.
3535
- A PR that addresses an issue must link it with a closing keyword (`Closes #123`, `Fixes #123`) in the PR body, so merging the PR closes the issue.
36+
- **Any issue an agent helped write or investigate carries the `ai-assisted` label and an `Assisted-by:` trailer**, following the [kernel's convention](https://docs.kernel.org/process/coding-assistants.html). Last line of the body, own paragraph:
37+
38+
```text
39+
Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2]
40+
```
41+
42+
`AGENT_NAME` is the agent or harness (`Claude`, `Codex`), `MODEL_VERSION` the model that did the work. The bracketed tools are optional and space-separated — the brackets mark optionality, they are not typed. List only named analysis tools that produced evidence in the body (`pytest`, `mypy`, `ruff`, `pyright`); an ad-hoc repro script is not a tool, so most issues carry none. Drop any bracketed context-window or deployment suffix from the model id, since literal brackets would read as the tool syntax — `Claude:claude-opus-5`, not `Claude:claude-opus-5[1m]`.
43+
44+
- Agents **MUST NOT** add a `Signed-off-by` trailer anywhere. Only a human can certify the DCO. `Assisted-by:` records help; it never signs for anyone. Commits keep the separate co-author trailer described in `CLAUDE.md` — don't put `Assisted-by:` on a commit or a PR body.
45+
- Say what you could _not_ do. An agent-filed issue states plainly whether the reproduction was actually run, whether a fix was built or tested, and what remains unverified. An unverified report that reads as verified costs a maintainer more than no report.
3646
- Connect issues with GitHub's relationships rather than restating context: `gh issue edit <n> --add-blocking <m>`, `--add-blocked-by`, and `--parent` / `--add-sub-issue` for a genuine parent-child breakdown.
3747

3848
### Upstream dependencies

0 commit comments

Comments
 (0)