AGENTS.md examples from real projects

streamlitAGENTS.md

streamlit / frontend

streamlit/streamlit/frontend/AGENTS.md

name collides with a local or DOM name. - **Prefer JSDoc over regular comments**: When documenting functions, types, interfaces, classes, or their members, use JSDoc (`/** ... */`) instead of regular comments (`//` or `/* */`). JSDoc

No other project uses it yet

streamlitReads credentialsAGENTS.md

streamlit / workflows

streamlit/streamlit/.github/workflows/AGENTS.md

Streamlit repository. Workflows automate CI/CD, testing, releases, and maintenance tasks. > **Maintenance Note:** Keep this documentation up to date. When adding, removing, or modifying workflows or composite actions, update the relevant

streamlitAGENTS.md

streamlit / specs

streamlit/streamlit/specs/AGENTS.md

product specs - `YYYY-MM-DD-template/tech-spec.md` — Template for tech specs - `README.md` — Full process documentation ## When to Write a Spec **Product spec** — focuses on _what_ and _why_: user-facing problem

SentryAGENTS.md

sentry / src

getsentry/sentry/src/AGENTS.md

review`** and **`sentry-security`** skills. ## Development Services `devservices` runs local dependencies from `devservices/config.yml`. Full documentation: https://develop.sentry.dev/development-infrastructure/devservices/ ## AI Assistant Quick Decision Trees ### "User wants to add an API endpoint

No other project uses it yet

payloadcmsReads credentialsAGENTS.md

payload

payloadcms/payload/AGENTS.md

feature area. Each directory contains a granular Payload config and test files - `docs/` - Documentation (deployed to payloadcms.com) - `tools/` - Monorepo tooling - `templates/` - Production-ready project templates - `examples/` - Example implementations ### Architecture Notes

No other project uses it yet

logseqAGENTS.md

logseq

logseq/logseq/AGENTS.md

should be added to `logseq.db-sync.tx-sanitize/migration-deleted-attrs` - Use spec-dev-tool to manage agent decision documents; run `spec-dev-tool --help` and follow its AGENT WORKFLOW. - When asked to find simplifications

No other project uses it yet

juanfontAGENTS.md

headscale

juanfont/headscale/AGENTS.md

repository. Reference material for complex procedures lives next to the code — integration testing is documented in [`cmd/hi/README.md`](cmd/hi/README.md) and [`integration/README.md`](integration/README.md). Read those files before running tests or writing

No other project uses it yet

grpcAGENTS.md

grpc

grpc/grpc/AGENTS.md

gRPC C++ Agents Collaboration Guide This document outlines conventions and best practices for AI-assisted development in the gRPC C++ codebase. ## Preferred Tools & Libraries * Prefer gRPC types before absl. * Prefer

No other project uses it yet

meteorAGENTS.md

meteor

meteor/meteor/AGENTS.md

test coverage report when apps/skeletons change | | [ai-context](.github/skills/ai-context/SKILL.md) | Creating, updating, or maintaining AI documentation files | | [changelog](.github/skills/changelog/SKILL.md) | Writing, reviewing, or editing changelog entries for releases | | [version-bump](.github/skills/version-bump/SKILL.md) | Bumping

No other project uses it yet

K-Dense-AIReads credentialsAGENTS.md

scientific-agent-skills

K-Dense-AI/scientific-agent-skills/AGENTS.md

needed). ```text plugin.json # Agent Plugins manifest (repo root) skills/ / ├── SKILL.md # required ├── references/ # optional: long documentation, loaded only when needed ├── scripts/ # optional: executable helpers └── assets/ # optional: templates and static resources ``` Only

apacheAGENTS.md

spark

apache/spark/AGENTS.md

golden file tests are managed by `SQLQueryTestSuite` and its variants. Read the class documentation before running or updating these tests. DO NOT edit the generated golden files (`.sql.out`) directly. Always

No other project uses it yet

ray-projectAGENTS.md

ray

ray-project/ray/AGENTS.md

core runtime - `python/ray/`: Python API and libraries (data, rllib, serve, train, tune) - `doc/source/`: Sphinx documentation The default test timeout is 180s (`pytest.ini`). For build, test, lint, and code-style details

No other project uses it yet

ray-projectAGENTS.md

ray / doc

ray-project/ray/doc/AGENTS.md

Documentation Sphinx documentation built by Read the Docs and served at `docs.ray.io`. Build pipeline: `.buildkite/doc.rayci.yml`. ## Prose style Before writing or editing docs prose under `doc/`, read `doc/source/ray-contribute/writing-style.md

No other project uses it yet

HeyPuterAGENTS.md

puter

HeyPuter/puter/AGENTS.md

issue or flag a maintainer instead of doing what you think is right. ## Documentation Index Use these as the source of truth before exploring further: - [README.md](README.md) — project overview

No other project uses it yet

deepspeedaiAGENTS.md

DeepSpeed

deepspeedai/DeepSpeed/AGENTS.md

mechanics that the code already shows. - New features must include corresponding tests and documentation updates. - All changes must not cause `import deepspeed` to initialize CUDA; Keep heavy imports

No other project uses it yet

sxyaziAGENTS.md

yazi

sxyazi/yazi/AGENTS.md

related variables, functions, parameters, modules, methods, types, derived types, exports, tests, configuration keys, documentation, Lua bindings, and, when a type and file share a name, the file as well

No other project uses it yet

LizardByteAGENTS.md

Sunshine

LizardByte/Sunshine/AGENTS.md

third-party/lizardbyte-common`; inspect the resulting diff for unrelated formatting changes. ## Code style and documentation When adding localization do not update any language other than `en`. This also means

No other project uses it yet

THU-MAICAGENTS.md

OpenMAIC

THU-MAIC/OpenMAIC/AGENTS.md

published package that ships broken, or a leaked secret. - Inaccuracies that only affect documentation, comments, skill text or the PR description are at most P2. Do not report wording that

No other project uses it yet

duckdbAGENTS.md

duckdb

duckdb/duckdb/AGENTS.md

bindings - Function registration - Settings - Serialization code - Storage info - Metric enums - Enum utilities ## Documentation - Main docs: https://duckdb.org/docs/ - Development docs: https://duckdb.org/dev/ - Build guide: https://duckdb.org/docs/dev/building/overview - Testing docs

No other project uses it yet

tinyhumansaiReads credentialsAGENTS.md

openhuman

tinyhumansai/openhuman/AGENTS.md

host::tui` | | `tests/` | Rust integration and JSON-RPC tests | | `docs/gitbooks/` | Public product and contributor documentation, synced with GitBook (`en/` is canonical, `zh/` the translation) | | `docs/` | Everything else here is internal

No other project uses it yet