docs: share agent guidance through AGENTS.md - #2140
Conversation
|
Reviewed at 016cb6b. Thanks for calling out that the move hides the content changes, and for listing the two additions separately. I did not take that on trust, so for the record: I extracted the pre-merge I also checked that The file is 20.8 KiB, comfortably under the 32 KiB limit you cite, and the docs-only check roster ran green. I want two things before this goes in, plus one verification. 1. The closure rule is missing its strongest vector: commit messages. The rule currently reads:
GitHub also acts on auto-closing references in commit messages that land on the default branch, which is a separate path from the PR description and is not covered by the sentence above. On a rebase or merge commit, a contributor's own commit message reaches main verbatim, so this is the one place where a contributor can trigger closure without ever writing it in a description. Please add commit messages to that list. This is the rule I care most about in the PR, and it currently has a hole in exactly the spot that catches people. 2. Four documentation cross-references now point at a stub. These cite
The links still resolve, so the checklist item is accurate as written, but a reader following one now lands on a five-line alias and has to take a second hop to reach the constraint being cited. Two things I would rather you left alone:
3. The one thing you did not test is the one that decides this. You were straight about it, and I appreciate that: "Interactive startup of both agents was not tested." Everything else here is verifiable from the diff, but whether Please confirm the import actually loads in a real session before this merges, by whatever check shows you the resolved instructions. If it turns out not to resolve, I would rather keep the content in On the two rules as policy: I am adopting both. English for repository-facing text is what the repo already does in practice and it is worth stating. The closure rule I have been enforcing without having written it down, which is not fair to anyone submitting a first PR, so having it in the file is an improvement on the status quo regardless of the rest of this change. One small note, no action needed: Claude Code may read |
|
Addressed the review findings:
All PR checks are green. |
What this PR does
Makes
AGENTS.mdthe shared source of repository guidance for Codex and Claude Code, and adds two substantive contribution rules described below. These additions are called out explicitly because the file move makes them difficult to distinguish in the diff.Content changes to review
The following two rules are new under PR & commit conventions:
1. Use English for all repository-facing text
Requires English for PR titles and descriptions, commit messages, issues, review comments, documentation, and code comments. App translations retain their intended target languages.
2. Leave issue closure to maintainers
Requires neutral issue references such as
Refs #N. PR descriptions and comments must avoid auto-closing keyword + issue references, including in quoted text. Maintainers decide when a report is resolved and its issue should be closed.No other existing guidance is changed, apart from renaming the document heading from
CLAUDE.mdtoAGENTS.md.File move and compatibility
CLAUDE.mdtoAGENTS.mdso Codex discovers it automatically.CLAUDE.mdas a thin alias containing a Markdown link and an@AGENTS.mdimport, so Claude Code reads the same instructions without a second maintained copy.References: Codex instruction discovery, Importing AGENTS.md in Claude Code.
Type of change
How it was tested
AGENTS.mdremains below Codex's default 32 KiB limit.git diff --checkpassed.python3 Tools/doc_comment_lint.pypassed.python3 Tools/i18n_audit.py --ci origin/mainpassed.Checklist