Skip to content

Commit 88b6819

Browse files
alxmrsclaude
andcommitted
Allow a workaround's TODO to name the issue that removes it, in AGENTS.md
The TODO on copying a plan names datafusion-python's missing binding of reset_plan_states (#283). Record the exception, and the rule to introduce every reference, which the ML demos' branch adds identically. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01NyN7idACeDMh94qrnFMu6h
1 parent 560fa8e commit 88b6819

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

‎AGENTS.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,16 @@ summarizes recurring maintainer review feedback so changes land clean.
88
- Keep docstrings and comments self-contained. Do **not** put GitHub issue or PR
99
numbers in docstrings or code comments; a reader should not need the issue
1010
tracker to understand the code. Issue references belong in the commit message
11-
and PR description (e.g. `Closes #189`), not in the source.
11+
and PR description (e.g. `Closes #189`), not in the source. The one exception
12+
is a workaround's `TODO`, which names the issue that would remove it:
13+
`TODO(#NN): <action item>`, or `TODO(owner/repo#NN): <action item>` for an
14+
issue in another repository. The comment still explains the workaround.
15+
- Introduce every reference before relying on it. The first time a document
16+
(a docstring, comment, README or docs page) mentions a project, paper,
17+
algorithm, dataset or term of art, such as einfold, FlashAttention or a
18+
section of another project's design, say in a few words what it is, and link
19+
it where there is a link. Don't assume the reader has the context of the
20+
conversation that produced the code.
1221
- Do not reference the review conversation, chat, or "the reporter" in comments.
1322
Describe the behavior, not how it came up.
1423

0 commit comments

Comments
 (0)