AGENTS.md examples from real projects

vimAGENTS.md

vim

vim/vim/AGENTS.md

runtime/syntax/testdir` - Tests for Indent runtime are in `runtime/indent/testdir` ## Common gotchas - **Distinguish what code enforces from what docs claim.** If a patch changes documented behavior, say so in the Problem/Solution. - **Generated

No other project uses it yet

HmbownReads credentialsAGENTS.md

CodeWhale

Hmbown/CodeWhale/AGENTS.md

lane is obsolete, preserve its intent and evidence rather than merging stale code mechanically. - Agent-owned work uses the canonical checkout on current `main`. Do not create branches, worktrees, nested

ToolJetReads credentialsAGENTS.md

ToolJet

ToolJet/ToolJet/AGENTS.md

changes. Keep evidence links current, preserve explicit inference labels, and review map changes with the same owners as the code. Stale context is worse than no context

ToolJetAGENTS.md

ToolJet / frontend

ToolJet/ToolJet/frontend/AGENTS.md

that still passes against broken production code certifies nothing. **Full reference: `src/test/README.md`** (all frontend code). Review rules: `.github/instructions/frontend-tests.instructions.md`. - **Stack:** Jest + Testing Library + MSW. - **Layout:** - specs are `*.spec.*` in a colocated

HmbownAGENTS.md

Codewhale

Hmbown/Codewhale/AGENTS.md

lane is obsolete, preserve its intent and evidence rather than merging stale code mechanically. - Agent-owned work uses the canonical `/Volumes/VIXinSSD/CW/codewhale` checkout on current `main`. Do not create branches, worktrees

vuetifyjsAGENTS.md

vuetify

vuetifyjs/vuetify/AGENTS.md

code-readability.md` | `packages/vuetify/src/**` | ## Review rubric Each item is a real finding when a diff violates it. Details in the rule named at the end. - Comments that narrate code, or reference issues/URLs

No other project uses it yet

pingcapAGENTS.md

tidb

pingcap/tidb/AGENTS.md

subsystem and the closest existing tests (`Repository Map`, `Task -> Validation Matrix`). Before changing or reviewing code behavior, agents MUST read the target package's `doc.go` when present. Pure spelling

No other project uses it yet

GitHubAGENTS.md

awesome-copilot

github/awesome-copilot/AGENTS.md

your contribution works with GitHub Copilot - [ ] Checked that file names follow the naming convention ### Code Review Checklist For instruction files (\*.instructions.md): - [ ] Has markdown front matter - [ ] Has non-empty `description` field

GitHubAGENTS.md

awesome-copilot / templates

github/awesome-copilot/skills/setup-my-iq/assets/templates/AGENTS.md

voice, formatting rules | `communicationStyle` | | Working preferences, hard rules | `preferencesAndConstraints` | | "Tell me about myself" / broad review | All six | Cross-cutting questions (e.g., "what do I do for team X?") may require

No other project uses it yet

Yeachan-HeoAGENTS.md

oh-my-claude-sisyphus

Yeachan-Heo/oh-my-claude-sisyphus/AGENTS.md

validation, test adequacy Review Lane: - `/prompts:style-reviewer`: Formatting, naming, idioms, lint conventions - `/prompts:code-reviewer`: Comprehensive review — logic defects, maintainability, anti-patterns, style, performance - `/prompts:api-reviewer`: API contracts

Yeachan-HeoAGENTS.md

oh-my-claude-sisyphus / skills

Yeachan-Heo/oh-my-claude-sisyphus/skills/AGENTS.md

recovery | | `remember/SKILL.md` | remember | Review reusable project knowledge and decide what belongs in project memory, notepad, or durable docs | | `self-improve/SKILL.md` | self-improve | Autonomous evolutionary code improvement engine with tournament

photoprismReads credentialsAGENTS.md

photoprism

photoprism/photoprism/AGENTS.md

include in code comments:** Issue / PR numbers, "previously…" history, alternatives considered, what the function used to do, references to old commits, names of subsequent reviewers, or any narrative that names

PostHogAGENTS.md

posthog

PostHog/posthog/AGENTS.md

monitor it, or resolve its blockers. Agents may inspect status, fix code and CI, request a stamphog review when a required approval is missing (MCP first, label fallback, see `/merging-prs

novuhqReads credentialsAGENTS.md

novu

novuhq/novu/docs/AGENTS.md

Bold for UI elements: Click **Settings** - Code formatting for file names, commands, paths, and code references - Capitalize **Novu** and product names: Inbox, Framework, Dashboard - Include frontmatter `title` and `description

No other project uses it yet

HKUDSReads credentialsAGENTS.md

LightRAG

HKUDS/LightRAG/AGENTS.md

this separates: it buries the code, and the same facts in two places drift apart. Two rules are enforced by `tests/test_docstring_budget.py` rather than by review, because both are properties

No other project uses it yet

videojsAGENTS.md

video.js

videojs/video.js/AGENTS.md

after inspecting relevant project sources. - API: `design-api`, `review-api` - Bundler plugins: `create-rolldown-plugin`, `create-vite-plugin`, `transform-rolldown-code` - VJSC component anatomy: `create-vjsc-component` - UI implementation: `create

No other project uses it yet

videojsAGENTS.md

video.js / site

videojs/video.js/site/AGENTS.md

semantic utilities. - Use the custom `intent:` variant for pointer/focus intent where existing site code does; do not replace it mechanically with `hover:`. - Prefer a token-based utility when one fits

No other project uses it yet

QuivrHQAGENTS.md

quivr

QuivrHQ/quivr/AGENTS.md

mailboxes, accounts, volumes, configurations, meeting notes or quotes from private tickets. That applies to code, tests, fixtures, docs, comments, commit messages and pull-request text. Write features and docs

No other project uses it yet

rapid7AGENTS.md

metasploit-framework

rapid7/metasploit-framework/AGENTS.md

exploit. It aborts on a nonvulnerable target unless the operator uses `set ForceExploit true`. ## Code Review Rules - Review the full PR description and available linked issues, module documentation, and review

hyprwmAGENTS.md

Hyprland

hyprwm/Hyprland/AGENTS.md

status of the PR (draft, ready, closed), accept or deny suggestions, answer to code reviews, participate in conversations, and any other way of directly interacting with the PR. The user