AGENTS.md examples from real projects

omacomReads credentialsAGENTS.md

omarchy

omacom/omarchy/AGENTS.md

visual effect in the running UI - [`agents/skills/migrations.md`](agents/skills/migrations.md) - creating or changing migrations under `migrations/` # Documentation Layout Three documentation trees, split by genre and audience: - `agents/skills/` - task procedure ("do this when

cliAGENTS.md

cli

cli/cli/AGENTS.md

narration of the code. - Use ordinary hyphens, not em dashes, in code, comments, and documentation. Before preparing or updating a PR, read the [PR template](.github/PULL_REQUEST_TEMPLATE.md) fresh. Keep its headings

No other project uses it yet

DIYgodAGENTS.md

RSSHub

DIYgod/RSSHub/AGENTS.md

fallback for `pubDate`. If no date is available, leave it undefined. See [No Date documentation](https://docs.rsshub.app/joinus/advanced/pub-date#no-date). 22. **No Title Trimming**: Do not manually trim or truncate titles. RSSHub

No other project uses it yet

serverlessReads credentialsAGENTS.md

serverless

serverless/serverless/AGENTS.md

Runtime API bridge + exec wrapper for the Dev Mode layer ├── docs/sf/ # User-facing documentation (published to serverless.com) ├── skills/ # Agent Skills shipped inside the CLI (CI-linted) └── release-scripts/ # Release automation

No other project uses it yet

files-communityAGENTS.md

Files

files-community/Files/AGENTS.md

safe and are not acceptable exemptions. - Keep suppressions of trimming or AOT diagnostics local, document why the reflected members remain available, and verify the relevant AOT build. ### WinRT server

streamlitAGENTS.md

streamlit

streamlit/streamlit/AGENTS.md

tech specs for Streamlit features. - `.github/workflows/`: GitHub Actions workflows used for CI/CD. - `wiki/`: Documentation relevant for development of Streamlit. ## Shell & Build Policy - Prefer `make` targets for all dev tasks (tests

No other project uses it yet

streamlitAGENTS.md

streamlit / skills

streamlit/streamlit/.claude/skills/AGENTS.md

SKILL.md # Required: Instructions for the AI agent ├── scripts/ # Optional: Executable code ├── references/ # Optional: Additional documentation └── assets/ # Optional: Static resources ``` ### SKILL.md format The `SKILL.md` file must include YAML frontmatter and markdown

No other project uses it yet

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

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

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

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

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

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

Niko1221AGENTS.md

Strata

Niko1221/Strata/AGENTS.md

fallback for a developer or for a system with no release package; it is documented in [docs/SOURCE_INSTALL.md](docs/SOURCE_INSTALL.md). Those wrappers exist in a source checkout, not in the released

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