AGENTS.md examples from real projects

vuetifyjsAGENTS.md

vuetify

vuetifyjs/vuetify/AGENTS.md

vuetify` npm package - `packages/api-generator` — builds API data (props, events, slots, descriptions) for docs - `packages/docs` — documentation site Contributor guide: `packages/docs/src/pages/en/getting-started/contributing.md` Supported browsers: `packages/docs/src/pages/en/getting-started/browser-support.md` ## Branches | Base | For | Docs | |----------|-------------------------------------------------------|--------------------| | `master` | safe bug fixes

No other project uses it yet

nushellAGENTS.md

nushell

nushell/nushell/AGENTS.md

without adding a pile of new helpers: reuse the helpers that already exist. Document new code. - Don't run `cargo clean`; it forces a full recompile on the next build

No other project uses it yet

schollzAGENTS.md

croc

schollz/croc/AGENTS.md

workflow. GitHub Actions and release operations continue to use the GitHub CLI (`gh`) as documented below. ## Releasing croc Releases are prepared by the **Prepare Release** GitHub Actions workflow

No other project uses it yet

Yeachan-HeoAGENTS.md

oh-my-claudecode

Yeachan-Heo/oh-my-claudecode/AGENTS.md

agent). - Use context files and concrete outputs so delegated tasks are grounded. - Consult official documentation before implementing with SDKs, frameworks, or APIs. - For cleanup or refactor work, write a cleanup

Yeachan-HeoAGENTS.md

oh-my-claudecode

Yeachan-Heo/oh-my-claudecode/docs/AGENTS.md

docs User documentation and technical guides for oh-my-claudecode. ## Purpose This directory contains documentation for end-users and developers: - **End-user guides**: How to use oh-my-claudecode features

Yeachan-HeoAGENTS.md

oh-my-claudecode / skills

Yeachan-Heo/oh-my-claudecode/skills/AGENTS.md

open question and return grounded, sourced findings | | `external-context/SKILL.md` | external-context | Invoke parallel document-specialist agents for external web searches and documentation lookup | | `autoresearch/SKILL.md` | autoresearch | Stateful single-mission improvement

No other project uses it yet

Yeachan-HeoAGENTS.md

oh-my-claudecode / src

Yeachan-Heo/oh-my-claudecode/src/AGENTS.md

Create feature directory in `features/` 2. Export from `features/index.ts` 3. Update `docs/FEATURES.md` with API documentation #### TypeScript Conventions - Use strict mode (`noImplicitAny`, `strictNullChecks`) - Prefer interfaces over type aliases for public APIs

PostHogAGENTS.md

posthog

PostHog/posthog/AGENTS.md

titles. - When a change touches user-facing behavior, an API, a config/setting, or a documented workflow, update an existing doc under `docs/` **whose scope covers that behavior** in the same

pingcapAGENTS.md

tidb

pingcap/tidb/AGENTS.md

format: `PLANS.md` at repository root. - Requirement: keep the ExecPlan updated as a living document while implementation progresses. - Scope: use this for multi-step work where losing context would risk correctness

No other project uses it yet

HKUDSReads credentialsAGENTS.md

LightRAG

HKUDS/LightRAG/AGENTS.md

based knowledge representation for enhanced information retrieval. The system extracts entities and relationships from documents, builds a knowledge graph, and uses multiple retrieval modes (`local`, `global`, `hybrid`, `mix`, `naive

photoprismReads credentialsAGENTS.md

photoprism

photoprism/photoprism/AGENTS.md

what the code was already supposed to do: `Bug` (implemented, but not working as documented), `Enhancement` (new capability on working functionality), `Feature` (entirely new), or `Task` (never fully developed, needs

No other project uses it yet

photoprismAGENTS.md

photoprism / frontend

photoprism/photoprism/frontend/AGENTS.md

Full rules: `specs/frontend/translations.md` §"Case Conventions". ## Focus Management - Dialogs must follow the shared focus pattern documented in `frontend/src/common/README.md`. - Always expose `ref="dialog"` on ` ` overlays, call `$view.enter` and `$view.leave` in `@after-enter

No other project uses it yet

novuhqReads credentialsAGENTS.md

novu

novuhq/novu/docs/AGENTS.md

Documentation project instructions ## About this project - Novu is the open-source notification infrastructure for in-app (Inbox), email, SMS, push, and chat - This is a documentation site built on [Mintlify

No other project uses it yet

gofiberAGENTS.md

fiber

gofiber/fiber/AGENTS.md

surrounding code. - Keep all protocol behavior RFC-compliant (e.g., HTTP/1.1 requirements) and document any intentional deviations. - Protect hot paths from regressions: profile changes. - Apply secure-by-default choices (validation, timeouts

videojsAGENTS.md

video.js

videojs/video.js/AGENTS.md

apps/sandbox`: Vite playground. `templates/` is tracked; `src/` is scratch. - `apps/e2e`: Playwright coverage. - `site`: Astro documentation site; follow `site/AGENTS.md`. Keep framework-neutral packages free of DOM or framework dependencies. Put platform

No other project uses it yet

videojsAGENTS.md

video.js / site

videojs/video.js/site/AGENTS.md

React context. - React Compiler is enabled; do not add memoization without a measured or documented need. ## Content - Read `src/content/docs/writing-style/write-guides.mdx` before adding or reviewing site prose. It owns document types, frontmatter

No other project uses it yet

chatwootAGENTS.md

chatwoot

chatwoot/chatwoot/AGENTS.md

strong params and existing errors so invalid input returns `422 Unprocessable Entity`. - Accept only documented input types, shapes, and values. Fix malformed official clients instead of adding compatibility coercions. - Prefer

No other project uses it yet

DioxusLabsAGENTS.md

dioxus

DioxusLabs/dioxus/AGENTS.md

communication protocol ├── interpreter/ # Sledgehammer JS for DOM mutations └── wasm-split/ # WASM code splitting ``` ## Architecture Documentation For deeper understanding, see `notes/architecture/`: | When working on... | Read... | | ------------------------------------------ | ------------------ | | VirtualDOM, components, diffing, events | `01-CORE.md

QuivrHQAGENTS.md

quivr

QuivrHQ/quivr/AGENTS.md

pull-request text. Write features and docs for any organization, with neutral examples, and document how to configure them instead of configuring them for someone. Customer context stays in Linear

rapid7AGENTS.md

metasploit-framework

rapid7/metasploit-framework/AGENTS.md

tools/` — Developer and operational tools - `plugins/` — msfconsole plugins - `scripts/` — Example automation scripts - `documentation/modules/` — Markdown documentation for Metasploit modules ## Coding Conventions - Discover the current Ruby version from `.ruby-version` and supported