AGENTS.md examples from real projects

quasarframeworkAGENTS.md

quasar / ui

quasarframework/quasar/ui/AGENTS.md

dist` fresh and fixtures deterministic. The harness contract (takeover rule, `quasarOptions`, `setupApp`/router) is documented in `test/hydration/hydrate.js`. `pnpm test:hydration:pwa` covers the `__QUASAR_SSR_PWA__` gate — the server-rendered

agentskillsAGENTS.md

agentskills

agentskills/agentskills/AGENTS.md

configuration, or policy here. ## Authority and boundaries `docs/specification.mdx` is authoritative for format requirements. Explanatory documentation, examples, tests, and implementations do not add requirements to the format. Preserve the distinction between

icsharpcodeAGENTS.md

ILSpy

icsharpcode/ILSpy/AGENTS.md

suite (test kinds, fixture structure, how to write tests, the compiler-matrix model) is documented in [ICSharpCode.Decompiler.Tests/AGENTS.md](ICSharpCode.Decompiler.Tests/AGENTS.md). - After matcher / rewriter edits, **run the relevant tests, not just the build

No other project uses it yet

marmelabAGENTS.md

react-admin

marmelab/react-admin/Agents.md

commerce demo │ ├── crm/ # CRM application │ └── tutorial/ # Tutorial app ├── cypress/ # E2E test configuration ├── docs/ # Jekyll documentation ├── docs_headless/ # Astro + Starlight documentation for headless components └── scripts/ # Build scripts ``` ## Package Dependencies - **Core**: React

No other project uses it yet

promptfooAGENTS.md

promptfoo / site

promptfoo/promptfoo/site/AGENTS.md

Documentation Site Docusaurus-based documentation at [promptfoo.dev](https://www.promptfoo.dev/). **Key rules:** - Don't start your own dev server for the site (ask user first) - Don't edit `CHANGELOG.md` (auto

No other project uses it yet

deepset-aiAGENTS.md

haystack / docs-website

deepset-ai/haystack/docs-website/AGENTS.md

docs-website/ Guidelines ## Documentation - Keep `docs-website` API names, import paths, and links current with public exports — link data-class symbols to anchored API docs and verify every MDX link

every-appAGENTS.md

open-seo

every-app/open-seo/AGENTS.md

version bump is needed. Call out plugin version and instruction changes for maintainer review. ## Documentation audience - `docs/` (except `docs/maintainers/`) and `web/content/docs/` are public, user-facing documentation. Write only material that

mozilla-aiAGENTS.md

llamafile

mozilla-ai/llamafile/docs/AGENTS.md

cloning or updating submodules - Submodule changes require patch files (see skill for workflow) ## Detailed Documentation For comprehensive build, architecture, development, and testing documentation, ask Claude about "how to build llamafile

MicrosoftAGENTS.md

winget-cli

microsoft/winget-cli/AGENTS.md

Keep each PR focused on one logical change. 3. Include or update tests and documentation when the change affects behavior, command output, user guidance, or public APIs. 4. Summarize validation

apacheAGENTS.md

flink

apache/flink/AGENTS.md

JobManager dashboard - `flink-external-resources` — External resource management (e.g., GPU) - `docs/` — Documentation content (Hugo site). This is where user-facing docs are written. - `flink-docs` — Documentation build module (auto-generated

rollupAGENTS.md

rollup

rollup/rollup/AGENTS.md

same change as the fix. - When changing or adding a feature, check if documentation in `docs/*/index.md` should be changed and update it in the same pull request. - Keep pull

rollupAGENTS.md

rollup

rollup/rollup/docs/AGENTS.md

mermaid block requires running `build:docs` locally and committing the SVG ## CLI Documentation - `cli/help.md` is hand-written (at build time only `//region` markers are stripped and `__VERSION__` replaced); the docs

goauthentikAGENTS.md

authentik

goauthentik/authentik/AGENTS.md

three Lit + PatternFly apps (Admin, User, Flow). | [`web/AGENTS.md`](web/AGENTS.md) | | **Docs** | `website/` | The documentation, integrations, and API sites (Docusaurus). | [`website/AGENTS.md`](website/AGENTS.md) | The Python core and the web UI talk through

goauthentikAGENTS.md

authentik / website

goauthentik/authentik/website/AGENTS.md

Project Overview This is the **authentik documentation website** — the source for everything published under `goauthentik.io`. It is a TypeScript [pnpm workspace](https://pnpm.io/workspaces) at `./website` that builds **three separate

vaporAGENTS.md

vapor

vapor/vapor/AGENTS.md

Automated Agent Policy This document outlines our policy on AI-assisted contributions and automated agents interacting with this project. ## Issues ### Good First Issues Issues tagged with `good-first-issue

zulipAGENTS.md

zulip

zulip/zulip/AGENTS.md

emphasized **high standards for codebase readability, code review, commit discipline, debuggability, automated testing, tooling, documentation, and all the other subtle details that together determine whether software is easy to understand

bazelbuildAGENTS.md

bazel

bazelbuild/bazel/AGENTS.md

Bazel Codebase Guide for Gemini Welcome to the Bazel repository. This document provides essential context and workflows for working with the Bazel codebase. ## 🏗️ Building & Running Bazel To build Bazel from

biomejsAGENTS.md

biome

biomejs/biome/AGENTS.md

user-facing. User-facing behavior requires a changeset; internal refactors, tests, CI, and documentation-only changes do not. For a user-facing change, load [changeset](./.agents/skills/changeset/SKILL.md) to choose the release

kieranklaassenAGENTS.md

compound-engineering-plugin

kieranklaassen/compound-engineering-plugin/AGENTS.md

that is not readily recoverable from the final code, tests, types, comments, or existing documentation, and losing it would plausibly cause recurrence, material risk, or substantial rediscovery. Apply this counterfactual

earthtojakePipes a download into a shellAGENTS.md

text-to-cad

earthtojake/text-to-cad/AGENTS.md

Read this file, then [CONTRIBUTING.md](CONTRIBUTING.md) for the workflows it points at; every other document is one link from the README of the tree it belongs to (Repo Map). ## Branch

No other project uses it yet