AGENTS.md examples from real projects

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

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

No other project uses it yet

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

lfnovoAGENTS.md

open-notebook / frontend

lfnovo/open-notebook/frontend/AGENTS.md

precise only when it matters. - Dark mode requires the `dark` class on the document root, not just `prefers-color-scheme`. It's hand-rolled: the zustand `theme-store` (persisted

No other project uses it yet

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

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

spacedriveappAGENTS.md

spacedrive

spacedriveapp/spacedrive/AGENTS.md

daemon. These are located in `apps/ios/` and `apps/macos/` but are private and not documented for public use. **Swift Client Generation:** For the prototypes, Swift types can be generated: ```bash cargo

No other project uses it yet

spacedriveappAGENTS.md

spacedrive / core

spacedriveapp/spacedrive/core/AGENTS.md

stored to allow the job to resume from where it left off. - **Documentation**: Use `//!` for module docs, `///` for public items, include examples - **Architecture**: Follow a Command Query Responsibility Segregation (CQRS

No other project uses it yet

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

ueberdosisAGENTS.md

tiptap

ueberdosis/tiptap/AGENTS.md

substitute for clearer code, naming, or structure. - Do not write prose paragraphs, mini-documentation, or essay-style explanations in implementation code. - Do not add examples, scenarios, or parenthetical explanations

directusAGENTS.md

directus

directus/directus/AGENTS.md

shared dependencies to the catalog first ## Changesets All code changes require a changeset to document what changed for the release notes. ### Creating a Changeset ```bash pnpm changeset ``` This interactive command

No other project uses it yet

CopilotKitAGENTS.md

CopilotKit

CopilotKit/CopilotKit/AGENTS.md

tested. Full rules in [Git & PRs](.claude/docs/git.md#commit-early-and-often-in-logical-chunks). - **Documentation lives in shell-docs** — author CopilotKit docs in `showcase/shell-docs/src/content/`. The top-level `docs/` path

No other project uses it yet

AdguardTeamReads credentialsAGENTS.md

AdGuardHome / client_v2

AdguardTeam/AdGuardHome/client_v2/AGENTS.md

design) - [Architecture](#architecture) - [Code Quality](#code-quality) - [Testing](#testing) - [Dependency Management](#dependency-management) - [Configuration \& Documentation](#configuration--documentation) - [Markdown Formatting](#markdown-formatting) - [Other](#other) - [Accessibility](#accessibility) - [Translations](#translations) # Project Overview `client

No other project uses it yet

keycloakAGENTS.md

keycloak

keycloak/keycloak/AGENTS.md

SECURITY.md](SECURITY.md). ## Contributing code See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on pull requests, testing, documentation, and commit messages

No other project uses it yet

VercelAGENTS.md

skills

vercel-labs/skills/docs/agents.md

Related Links - [Agent Skills Specification](https://agentskills.io) - [Skills Directory](https://skills.sh) - [Amp Skills Documentation](https://ampcode.com/manual#agent-skills) - [Antigravity Skills Documentation](https://antigravity.google/docs/skills) - [Factory AI / Droid Skills Documentation](https://docs.factory.ai

No other project uses it yet

nextcloudAGENTS.md

server

nextcloud/server/AGENTS.md

suggesting them. Do not use hallucinated or unverified package names. - Write code comments that document the code, never the process that produced it: - Comments describe what the code does - method

No other project uses it yet

can1357Reads credentialsAGENTS.md

oh-my-pi

can1357/oh-my-pi/AGENTS.md

model line, on any host). - `providers/*.kdl` — deployment contracts (behavior a host imposes), plus documented exact-id residue. - `runtime/behavior.kdl` — heuristics that run before/outside exact model lookup (`api-routes`, `model-limits

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