AGENTS.md examples from real projects

go-giteaAGENTS.md

gitea

go-gitea/gitea/AGENTS.md

guidelines-backend.md` for Go, `guidelines-frontend.md` for TS, CSS and Vue, both for templates, `testing.md` for tests, `development.md` for config options and migrations, `guidelines-refactoring.md` for refactors - PR descriptions: minimal, only what

No other project uses it yet

ultralyticsAGENTS.md

yolov5

ultralytics/yolov5/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

chen08209AGENTS.md

FlClash

chen08209/FlClash/AGENTS.md

agents/project.md): project overview, versions, and build dependencies. - [.agents/commands.md](.agents/commands.md): build, development, code generation, and test commands. - [.agents/rules.md](.agents/rules.md): lint, testing, generated-code, and workflow rules. Read these only when

No other project uses it yet

appwriteAGENTS.md

appwrite

appwrite/appwrite/AGENTS.md

Start per-queue worker and scheduler containers instead | | `docker compose exec appwrite test tests/e2e/Services/[Service]` | Run E2E tests for a service | | `docker compose exec appwrite test tests/e2e/Services/[Service] --filter=[Method

No other project uses it yet

coreyhaines31AGENTS.md

marketingskills

coreyhaines31/marketingskills/AGENTS.md

integration guides per tool │ └── REGISTRY.md # Tool index with capabilities ├── CONTRIBUTING.md ├── LICENSE └── README.md ``` ## Build / Lint / Test Commands **Skills** are content-only (no build step). Verify manually: - YAML frontmatter is valid - `name

router-for-meReads credentialsAGENTS.md

CLIProxyAPI

router-for-me/CLIProxyAPI/AGENTS.md

build -o cli-proxy-api ./cmd/server # Build go run ./cmd/server # Run dev server go test ./... # Run all tests go test -v -run TestName ./path/to/pkg # Run single test go build

FuelLabsAGENTS.md

fuel-core

FuelLabs/fuel-core/AGENTS.md

enforces warnings as errors. ## Commands (matrix) | Step | Command | | :--- | :--- | | Setup | `cargo fetch` | | Build | `cargo build` | | Test | `cargo test` | | **Format (required)** | `cargo +nightly-2025-09-28 fmt --all` then `-- --check` | | Lint | `cargo

No other project uses it yet

ayghriAGENTS.md

i-have-adhd

ayghri/i-have-adhd/AGENTS.md

plugin metadata. | | Documentation | `README.md`, `INSTALL.md`, `.github/readme/`, `.github/install/` | User-facing overview, installation, and translations. | | Verification | `tests/`, `scripts/` | Unit tests, compatibility checks, and evaluation tooling. | | Contribution workflow | `CONTRIBUTING.md`, `.github/pull_request_template.md` | Authorship, labels, safety

remix-runDeletes or force-pushesAGENTS.md

react-router

remix-run/react-router/AGENTS.md

Guide ## Commands - **Build**: `pnpm build` (all packages) or `pnpm run --filter build` (single package) - **Test (Jest)**: `pnpm test` (all packages), `pnpm test packages/ /` (single package), `pnpm test packages/react-router/__tests__/router/fetchers-test.ts` (single file

No other project uses it yet

BlockAGENTS.md

goose

block/goose/AGENTS.md

Build ```bash cargo build # debug cargo build --release # release just release-binary # release binary ``` ### Test ```bash export GOOSE_DISABLE_KEYRING=1 # avoid system keyring prompts cargo test # all tests cargo

TryGhostAGENTS.md

Ghost

TryGhost/Ghost/AGENTS.md

package READMEs. Start with: - [Development setup](docs/contributing/development-setup.md) - [Contribution workflow](docs/contributing/workflow.md) - [Writing codebase documentation](docs/contributing/documentation.md) - [Testing](docs/contributing/testing.md) - [Shipping](docs/contributing/shipping.md) - [Codebase direction](docs/codebase/direction.md) - [Monorepo structure](docs/codebase/monorepo-structure.md) ## Required workflow - Always use `pnpm`, never

TryGhostAGENTS.md

Ghost / e2e

TryGhost/Ghost/e2e/AGENTS.md

AGENTS.md Read the canonical human documentation before changing this workspace: - [Writing Browser E2E Tests](../docs/contributing/e2e-testing.md) covers test structure, Page Objects, locator priority, waiting, and validation. - The [E2E workspace README](./README.md

No other project uses it yet

bmad-code-orgAGENTS.md

BMAD-METHOD

bmad-code-org/BMAD-METHOD/AGENTS.md

Running and verifying - To validate skills: `uv run tools/validate_skills.py --strict`. - To run the Python tests: `uv run --frozen python -B -m pytest`. ## Conventions that differ from defaults - Skills, workflows, tasks

No other project uses it yet

ChromeDevToolsAGENTS.md

chrome-devtools-mcp

ChromeDevTools/chrome-devtools-mcp/AGENTS.md

scripts from `package.json` to run commands. - Use `npm run build` to run tsc and test build. - Use `npm run test` to build and run tests, run all tests to verify

No other project uses it yet

multica-aiReads credentialsAGENTS.md

multica

multica-ai/multica/AGENTS.md

from the repository root: | Scope | Checks | | --- | --- | | Frontend excluding mobile | `pnpm typecheck`, `pnpm lint`, `pnpm test` | | Go backend | `make test` | | End-to-end | `pnpm exec playwright test` | | Combined web/backend verification | `make

mozillaAGENTS.md

pdf.js

mozilla/pdf.js/AGENTS.md

bash npx gulp server ``` Then open http://localhost:8888/web/viewer.html to view the PDF viewer. Test PDFs are available at http://localhost:8888/test/pdfs/?frame ### Building Build for modern browsers: ```bash

No other project uses it yet

JetBrainsAGENTS.md

kotlin / analysis

JetBrains/kotlin/analysis/AGENTS.md

ownership with `withValidityAssertion` - Mark experimental APIs with `@KaExperimentalApi`, implementation details with `@KaImplementationDetail` ## Working with Test Data When modifying test data files or running generated tests (`*Generated`) that compare output against

JetBrainsAGENTS.md

kotlin / compiler

JetBrains/kotlin/compiler/AGENTS.md

mostly related to FIR (`compiler/fir/`), use `FIR: ` prefix in the commit subject line. - **Test-before-fix**: When fixing an issue and adding a test, commit the test data

No other project uses it yet

expoAGENTS.md

expo

expo/expo/AGENTS.md

Read first 1. Read [CONTRIBUTING.md](./CONTRIBUTING.md). It is the source for setup, package scripts, tests, documentation, and changesets. Do not copy those steps into a new guide

expoAGENTS.md

expo

expo/expo/docs/AGENTS.md

these from the `docs/` directory. Run them locally on every docs change: ```sh pnpm test # docs unit tests pnpm test:worker # Cloudflare worker and route tests NODE_ENV=production pnpm

No other project uses it yet