AGENTS.md examples from real projects

crewAIIncAGENTS.md

crewAI

crewAIInc/crewAI/AGENTS.md

practices and idiomatic patterns. 2. Maintain existing code structure and organization. 3. Write unit tests for new functionality focusing on behaivor and not implementation. 4. Document public APIs and complex

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

spring-projectsAGENTS.md

spring-framework

spring-projects/spring-framework/AGENTS.md

artifacts target Java 17+. - Scope builds to the modules you touched: `./gradlew :spring-webmvc:test`, a single test with `--tests `. - Run `./gradlew : :check` before finishing: it runs tests and Checkstyle

No other project uses it yet

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 - Before designing a feature or behavior

railsAGENTS.md

rails

rails/rails/AGENTS.md

them should not break others unless there's an explicit dependency. ## Testing Commands ### Running Tests in a Component From within the component directory (preferred method): ```bash cd actionview && bin/test

No other project uses it yet

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

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

Gathin23AGENTS.md

cleanyourtv

Gathin23/cleanyourtv/AGENTS.md

theme's `config.json`, for this TV. Do not edit the repo's docs, tests or other code, and do not open issues or pull requests unless the person asks

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

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

ChromeDevToolsAGENTS.md

chrome-devtools-mcp

ChromeDevTools/chrome-devtools-mcp/AGENTS.md

from `package.json` to run commands. - Use `npm run build` to compile the project and tests with GN and Ninja. - Update `src/BUILD.gn` or `tests/BUILD.gn` whenever adding, renaming, or removing `.ts` files

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

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

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

HKUDSReads credentialsAGENTS.md

DeepTutor

HKUDS/DeepTutor/AGENTS.md

encryption python scripts/install_extras.py math-animator # Manim; also needs system LaTeX/ffmpeg python scripts/install_extras.py dev # Test / lint tooling python scripts/install_extras.py all # Full + Manim + dev dependencies ``` Stop DeepTutor before module changes. Source supports

No other project uses it yet

multica-aiReads credentialsAGENTS.md

multica

multica-ai/multica/AGENTS.md

Next.js proxy reads. Lint enforces the import, `process.env`, and Web Storage rules outside tests (`packages/core/eslint.config.mjs`). | | `packages/ui/` | UI primitives and shared styles. No business logic or `@multica/core` imports. | | `packages/views/` | Shared web/desktop

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

NutlopeAGENTS.md

hallmark

Nutlope/hallmark/AGENTS.md

node skills/hallmark/scripts/theme.mjs validate skills/hallmark/references/themes/*.md node skills/hallmark/scripts/theme.mjs index && git diff --exit-code -- skills/hallmark/references/themes/index.json node --test skills/hallmark/scripts/*.test.mjs skills/hallmark/scripts/fixtures/*/*.test.mjs ``` Browser tests skip without Chrome and puppeteer-core, and they always