AGENTS.md examples from real projects

grafanaAGENTS.md

loki

grafana/loki/AGENTS.md

errors with `if err != nil { return ... }` - Use structured logging with leveled logging (`github.com/go-kit/log`) - Document all exported functions, types, and variables ### Testing - Always prefer `github.com/stretchr/testify/require` over `github.com/stretchr/testify/assert

QwenLMAGENTS.md

qwen-code

QwenLM/qwen-code/AGENTS.md

English ` .md` and a Chinese ` .zh-CN.md` version in the same directory, following the [design documentation requirements](docs/design/README.md). Add reciprocal language links and keep both versions complete and synchronized

No other project uses it yet

invoke-aiAGENTS.md

InvokeAI

invoke-ai/InvokeAI/AGENTS.md

frontend | [webv1/AGENTS.md](invokeai/frontend/webv1/AGENTS.md) | | Shared generated API contracts | [api/AGENTS.md](invokeai/frontend/api/AGENTS.md) | | CI, contribution tooling | [.github/AGENTS.md](.github/AGENTS.md) | | Documentation | `docs/README.md`, `docs/package.json`. Keep product docs current. | Frontend work targets **webv2**, served by default. `--webv2

reflex-devAGENTS.md

reflex

reflex-dev/reflex/AGENTS.md

Playwright tests/js/ # vitest unit tests for the shipped frontend javascript tests/benchmarks/ # performance benchmarks docs/ # documentation site (separate workspace member) ``` ## Code style - Concise, robust code. Reflex is a framework used

charmbraceletAGENTS.md

crush

charmbracelet/crush/AGENTS.md

Patterns - **Config is a Service**: accessed via `config.Service`, not global state. - **Tools are self-documenting**: each tool has a `.go` implementation and a `.md` description file in `internal/agent/tools/`. - **System prompts

No other project uses it yet

Hugging FaceAGENTS.md

lerobot

huggingface/lerobot/AGENTS.md

approval), `latest_deps_tests.yml` (daily lockfile upgrade), `security.yml` (TruffleHog), `release.yml` (PyPI publish on tags). - **`docs/source/`** — HF documentation (`.mdx` files). Per-policy READMEs, hardware guides, tutorials. Built separately via `docs-requirements.txt` and CI workflows

No other project uses it yet

Z-SiqiAGENTS.md

Clash-for-Windows_Chinese

Z-Siqi/Clash-for-Windows_Chinese/AGENTS.md

arbitrary command execution. - Never print or persist controller secrets in logs, tests, screenshots, or documentation. ## Tests - The canonical gate is `npm test` from the repository root. It must work

manaflow-aiAGENTS.md

cmux / cmux-browser

manaflow-ai/cmux/skills/cmux-browser/AGENTS.md

secrets. - Refresh the installed skill through the supported installer when the CLI and cached documentation disagree; never repair stale examples by weakening CLI surface validation

steveyeggeAGENTS.md

beads / engdocs

steveyegge/beads/engdocs/AGENTS.md

engdocs/ — contributor notes `engdocs/` holds contributor and internals documentation. It is read on GitHub, not published: local links must be exact relative file paths, and `TestEngdocsAndRootMarkdownLinks` in `test/docsync` fails

OtterMindAGENTS.md

Chat2DB

OtterMind/Chat2DB/AGENTS.md

behavior, prefer current source and tests, then repository-local workflows and scripts, and then documentation. For current runtime state, live evidence wins only after the process `cwd`, artifact, branch/ref

bagistoAGENTS.md

bagisto

bagisto/bagisto/AGENTS.md

workflow` | | The REST/GraphQL API | `bagisto-api-develop` / `bagisto-api-shop` / `bagisto-api-admin` | | Any documentation site — developer docs, user guide, screenshots | `bagisto-documentation` | **Load `bagisto-change-verification` before calling

locustioAGENTS.md

locust

locustio/locust/AGENTS.md

locust/test/`**: Unit and integration tests (pytest) - **`examples/`**: Example locustfiles demonstrating various patterns - **`docs/`**: Sphinx documentation (`.rst` format) ### Key Patterns - **Event-driven**: Uses gevent for concurrency; events for messaging (`event.py`) - **Pluggable

No other project uses it yet

alibabaAGENTS.md

druid

alibaba/druid/AGENTS.md

druid-admin/` — Cluster monitoring admin - `druid-wrapper/` — Wrapper utilities - `openspec/` — Architecture specs and change documentation ## Key Source Paths - `core/src/main/java/com/alibaba/druid/pool/` — Connection pool (`DruidDataSource`) - `core/src/main/java/com/alibaba/druid/sql/dialect/` — 30 SQL dialect parsers - `core/src/main/java/com/alibaba/druid/sql/parser/` — Core parser

Kilo-OrgAGENTS.md

kilocode

Kilo-Org/kilocode/AGENTS.md

only after a Java-version or missing-Java failure. | | CI/local guards | Run affected guards documented above, such as `bun run knip`, `bun run check-kilocode-change`, `bun run script/check-opencode-annotations.ts --worktree

No other project uses it yet

element-plusAGENTS.md

element-plus

element-plus/element-plus/AGENTS.md

packages/constants`, `packages/directives`, `packages/locale`: shared runtime packages. - `packages/element-plus`: package entry and bundle surface. - `docs`: VitePress documentation site. - `play`: local playground used for manual component testing. - `internal`: build, metadata, lint, and workspace

No other project uses it yet

VercelAGENTS.md

ai

vercel/ai/AGENTS.md

unified interface for multiple AI providers and framework integrations. - **Repository**: https://github.com/vercel/ai - **Documentation**: https://ai-sdk.dev/docs - **License**: Apache-2.0 ## Repository Structure This is a **monorepo** using pnpm workspaces

No other project uses it yet

rechartsAGENTS.md

recharts

recharts/recharts/AGENTS.md

list. Keep `prefers-color-scheme` (`colorScheme`) separate from Recharts theme selection, and use the documented fixture options or `@recharts-theme-*` tags for intentional exceptions. Run visual-regression tests and update

valkey-ioAGENTS.md

valkey

valkey-io/valkey/AGENTS.md

belong in `tests/` (Tcl integration tests). - If behavior or commands change, check whether related documentation also needs updating. ## Files to avoid touching unless required - Do not commit local runtime artifacts

Wox-launcherAGENTS.md

Wox

Wox-launcher/Wox/AGENTS.md

specific workflows, policies, session state, lifecycle management, native adapters, bridge declarations, tests, fixtures, and documentation together. Implementation language or platform alone does not determine ownership: Objective

eslintAGENTS.md

eslint

eslint/eslint/AGENTS.md

level directories are `bin/` (CLI entry point), `conf/` (configuration data), `docs/` (the documentation website), `messages/` (verbose text for certain runtime errors), `packages/` (separately published packages), `templates/` (templates for generated files