AGENTS.md examples from real projects

facebookAGENTS.md

docusaurus

facebook/docusaurus/AGENTS.md

components, and theme overrides - `_dogfooding/` - Hidden docs, blog and pages plugin instances for dogfooding, testing features and edge cases, making it easier to review on PR deploy previews ### Writing documentation

No other project uses it yet

webpackDeletes or force-pushesAGENTS.md

webpack

webpack/webpack/AGENTS.md

with a short plan before the first edit**: - **Goal as a check**: "add validation" → "tests for invalid inputs fail, then pass"; "fix the bug" → "a test reproduces it, then passes

No other project uses it yet

warpdotdevAGENTS.md

Warp

warpdotdev/Warp/AGENTS.md

endpoint (default: `http://localhost:8080`) - `WS_SERVER_URL` - WebSocket endpoint (default: `ws://localhost:8080/graphql/v2`) ### Testing - `cargo nextest run --no-fail-fast --workspace` - Run tests with nextest - `cargo test

coollabsioReads credentialsAGENTS.md

coolify

coollabsio/coolify/AGENTS.md

coolify (app, which also runs Reverb WebSockets and the terminal server), postgres, redis, vite, testing-host, mailpit, minio. ```bash # One dev instance per git branch (containers, volumes, VMs named after

No other project uses it yet

ChrisTitusTechReads credentialsAGENTS.md

winutil

ChrisTitusTech/winutil/AGENTS.md

edited directly. 4. **Never fabricate.** Do not invent file paths, function names, command output, test results, commit hashes, or API behavior. Read the file or run the command. 5. **Disagree

No other project uses it yet

2dustAGENTS.md

v2rayNG

2dust/v2rayNG/AGENTS.md

exception; agent inference cannot. - `Task scope` is the named files and behavior plus dependency, test, or build edits that a compiler or required validation proves necessary. Every other change

No other project uses it yet

traefikAGENTS.md

traefik

traefik/traefik/AGENTS.md

generate-webui` (Docker required) — they are not meant to be hand-edited. - `integration/` — integration tests; reusable fixtures under `integration/fixtures/`. - `docs/content/` — MkDocs sources for the public documentation. ## Before you edit Read

No other project uses it yet

scrapyAGENTS.md

scrapy

scrapy/scrapy/AGENTS.md

mypy` and `tox -e pylint`, and `tox -e docs` and `tox -e docs-tests` as well if you touched docs or docstrings. CI runs these first and skips the test

No other project uses it yet

localstackAGENTS.md

localstack

localstack/localstack/AGENTS.md

cloud stack that emulates AWS services (S3, Lambda, DynamoDB, etc.) for development and testing. It runs in Docker, provides AWS-like APIs locally, enabling offline workflows, integration testing

usememosAGENTS.md

memos

usememos/memos/AGENTS.md

never by rewriting the body. See `docs/design/README.md`. Verify current behavior in source code and tests, not in design documents. - Brand copy (tagline, descriptions, README intro) comes verbatim from [`BRAND.md

No other project uses it yet

gitAGENTS.md

git / po

git/git/po/AGENTS.md

reimplement. It generates `po/l10n-pending.json` with messages that need translation. ```shell l10n_extract_pending () { test $# -ge 1 || { echo "Usage: l10n_extract_pending " >&2; return 1; } PO_FILE="$1" PENDING="po/l10n-pending.json

ghostty-orgAGENTS.md

ghostty

ghostty-org/ghostty/AGENTS.md

Demit-macos-app=false` to skip building the app bundle and speed up compilation. - **Test (Zig):** `zig build test` - Prefer to run targeted tests with `-Dtest-filter` because the full

No other project uses it yet

ghostty-orgAGENTS.md

ghostty / macos

ghostty-org/ghostty/macos/AGENTS.md

macos/build.nu [--scheme Ghostty] [--configuration Debug] [--action build]` - Output: `macos/build/ /Ghostty.app` (e.g. `macos/build/Debug/Ghostty.app`) - Run unit tests directly with `macos/build.nu --action test` ## AppleScript - The AppleScript scripting definition is in `macos/Ghostty.sdef`. - Guard AppleScript

withastroAGENTS.md

astro

withastro/astro/AGENTS.md

YOUR changes made unused. - Don't remove pre-existing dead code unless asked. The test: Every changed line should trace directly to the user's request. # Goal-Driven Execution **Define

No other project uses it yet

marktextAGENTS.md

marktext

marktext/marktext/AGENTS.md

State management | Pinia 4 | | Routing | Vue Router 5 | | UI library | Element Plus | | Unit tests | Vitest 5 | | E2E tests | Playwright | | Package manager | pnpm >=10 workspace (`packageManager: pnpm@10.33.4`) | | Repo layout | pnpm

No other project uses it yet

ultralyticsAGENTS.md

ultralytics

ultralytics/ultralytics/AGENTS.md

solution. Avoid impossible-state handling, speculative flags, compatibility shims, policy scaffolding, and unrelated cleanup. Tests are out of scope by default — rely on existing coverage and focused validation; only

No other project uses it yet

BerriAIPipes a download into a shellAGENTS.md

litellm

BerriAI/litellm/AGENTS.md

maintain/change - modern In descending order of importance When adding new features, add meaningful tests. Don't add tests that don't check anything substantial and is there just to make

No other project uses it yet

BerriAIAGENTS.md

litellm

BerriAI/litellm/.circleci/AGENTS.md

runs only on its schedule, so the API pipelines that set `run_migration_tests` or `routing_parity_base` would stop running it. If main stops getting integration runs, check that

No other project uses it yet

pingchesuAGENTS.md

gsd-hermes

pingchesu/gsd-hermes/docs/AGENTS.md

research on user's decisions - Investigates implementation patterns for the specific phase domain - Detects test infrastructure for Nyquist validation mapping --- ### gsd-ui-researcher **Role:** Produces UI design contracts for frontend

git-df-scottAGENTS.md

claude-skills / get-shit-done

git-df-scott/claude-skills/get-shit-done/AGENTS.md

agents/`; docs are in `docs/`; logos and terminal images are in `assets/`. Root tests are in `tests/*.test.cjs`. The TypeScript SDK is isolated under `sdk/`, with source and Vitest tests