File measured on main at commit 485107f. Analysis written 2026-09-14. Star count is a snapshot from September 2026.
What kind of file this is
The broadest file in the directory. Alongside structure and commands it covers how to spell one domain term, how to classify a security finding, what a newsfragment is for, how the git remotes must be named, and what an agent may put in a commit trailer.
Quoted lines are verbatim from the file. Open one to see it where it sits.
One word, with its exceptions enumerated
House vocabulary
The term is written in title case in all prose. The carve-out covers literal code tokens, which keep their original spelling even inside fenced code blocks, and includes a further exception for anti-pattern quotes that show the wrong form in order to teach the rule.
How to classify a security finding
Three categories are defined for anything the agent might flag: actual vulnerabilities that violate the documented security model, known limitations that are already tracked, and deployment hardening that belongs in operator guidance rather than as a code issue. The authoritative document is linked, including its chapter on what is not considered a vulnerability.
Open the pull request, not the issue
Contribution etiquette
When the fix is already known, the file directs the agent past filing an issue. Two reasons are given: the PR already carries the title, description, diff and discussion, and an open issue attracts duplicate submissions. The exception is a workaround whose real fix is deferred, where the issue outlives the PR.
Deferred work linked from the code
A workaround, version cap or partial fix requires a tracking issue opened before the PR body is finalised, referenced by number in the PR, and linked at the workaround site in the code. The link is specified as a full URL rather than a bare number, because bare references do not resolve outside GitHub's web interface.
No agent co-author trailer
Hard prohibitions
The commit section ends with a line prohibiting the agent from adding itself as a co-author, with the stated distinction that agents are assistants rather than authors. A separate PR template field discloses the agent by name and version instead.
Remote names checked rather than assumed
Two remote names are fixed by convention. The agent is told to run git remote -v before any remote command, and where the names do not match, to surface the mismatch and propose the exact rename commands rather than silently working with what is there.
A coverage target with an upper bound
Tests are to cover exactly what the PR changes: every changed behavior gets a test, every test must fail without the change, and tests for pre-existing logic or third-party functions are excluded.
Takeaways for your own repo
If your project has a term people spell three ways, fix the spelling and enumerate the exceptions.
Tell agents how to classify a security finding, including which categories not to report.
State whether an agent may add itself as a commit co-author.
Before any remote command, have the agent verify remote names rather than assume them.
"Every test must fail without the change" is a sharper instruction than a coverage percentage.
Airflow's file tells an agent how the codebase works. It cannot tell it which bug three customers hit this week. Modem keeps that context current and attaches it to the work.