AGENTS.md examples from real projects

facebookAGENTS.md

infer

facebook/infer/AGENTS.md

pattern `{lang}_{analyzer}`, e.g., `direct_java_pulse_test`, `direct_cpp_pulse_test`, `direct_c_frontend_test`. These are defined in the `DIRECT_TESTS` variable in the root Makefile. ### Test structure

open-metadataAGENTS.md

OpenMetadata

open-metadata/OpenMetadata/AGENTS.md

discovery, observability, and governance — a multi-module project with a Java backend, a React/TypeScript frontend, a Python ingestion framework, and Docker infrastructure. ## Stack at a glance - **Backend**: Java 21 + Dropwizard

documensoAGENTS.md

documenso

documenso/documenso/AGENTS.md

Handling & Validation - Use custom AppError class when throwing errors - When catching errors on the frontend use `const error = AppError.parse(error)` to get the error code - Use early returns and guard

zitadelAGENTS.md

zitadel

zitadel/zitadel/AGENTS.md

separate table for history/audit, but events are not the system of record. - **Frontend**: - **Console**: Angular + RxJS. - **Login/Docs**: Next.js + React. ## ZITADEL Domain & Multi-Tenancy Logic ### 1. Hierarchy & Ownership ZITADEL follows

zitadelAGENTS.md

zitadel / packages

zitadel/zitadel/packages/AGENTS.md

ZITADEL Packages Guide for AI Agents ## Context `packages/` contains shared TypeScript libraries used by frontend applications and external consumers. ## Main Packages - **`packages/zitadel-proto`** (`@zitadel/proto`): generated protobuf TypeScript artifacts. - **`packages/zitadel-client`** (`@zitadel/client`): higher

jupyterlabAGENTS.md

jupyterlab

jupyterlab/jupyterlab/AGENTS.md

disposables) - **Extension plugin examples**: `packages/*-extension/src/index.ts` - **TypeScript Style Guide**: https://github.com/jupyterlab/jupyterlab/wiki/TypeScript-Style-Guide ## Technology Stack - Frontend: TypeScript, React 18, Lumino (widgets), CodeMirror 6 - Backend: Python, Jupyter Server, Tornado, Traitlets - Build: Rspack

ChocobozzzAGENTS.md

PeerTube

Chocobozzz/PeerTube/AGENTS.md

distributed runners. ## Repository Structure - **apps/** — Standalone CLI applications (`peertube-cli`, `peertube-runner`) - **client/** — Angular frontend SPA (separate build system) - **config/** — YAML configuration files for dev, test, and production - **packages/** — Shared

ChocobozzzAGENTS.md

PeerTube / client

Chocobozzz/PeerTube/client/AGENTS.md

Client — Angular Frontend SPA PeerTube's web client is an Angular single-page application served under `/client/`. It communicates with the backend exclusively through the REST API (`/api/v1/`). A separate

No other project uses it yet

caproverAGENTS.md

caprover

caprover/caprover/AGENTS.md

data contracts. - `src/utils/CaptainConstants.ts`: runtime configuration, identifiers, and filesystem paths. - `tests/`: Jest regression tests. The frontend is maintained in `caprover/caprover-frontend`. User-facing documentation is maintained in `caprover/caprover-website`. For releases, hotfixes

alexta69AGENTS.md

metube

alexta69/metube/AGENTS.md

wiki. ## Tech stack - **Backend:** Python 3.13+, aiohttp, python-socketio 5.x, yt-dlp - **Frontend:** Angular 22, TypeScript, Bootstrap 5, SASS, ngx-socket-io - **Package managers:** uv (Python), pnpm (frontend) - **Container

grokabilityReads credentialsAGENTS.md

snipe-it

grokability/snipe-it/AGENTS.md

table, $item_id = null)` — post-checkout redirect logic. === .ai/snipe-it-stack rules === # Snipe-IT Stack & Tooling ## Frontend Is Laravel Mix, Not Vite - Assets are built with **Laravel Mix (webpack)** via `webpack.mix.js`. This

No other project uses it yet

yusufkaraaslanReads credentialsAGENTS.md

Skill_Seekers

yusufkaraaslan/Skill_Seekers/AGENTS.md

server are unaffected. Local web app: React 19 + Vite + Tailwind/shadcn frontend in `ui/`, FastAPI backend in `src/skill_seekers/web/`. ```bash # Run the app (opens browser; API on :8770) skill-seekers ui # Frontend

bytebaseAGENTS.md

bytebase

bytebase/bytebase/AGENTS.md

around it. ## Read before working - Before exploring domain behavior, read [domain guidance](docs/agents/domain.md). - For frontend work, read [frontend/AGENTS.md](frontend/AGENTS.md); before changing UI, also read the [UX contract](docs/agents/frontend-ux.md). - Before adding

bytebaseAGENTS.md

bytebase / frontend

bytebase/bytebase/frontend/AGENTS.md

under `./frontend/`. ## Inheritance - Follow the repository-wide guidance in `../AGENTS.md`. - Treat this file as frontend-specific additions, not a replacement for the root instructions. ## React - All product UI code

QloappsDeletes or force-pushesAGENTS.md

QloApps

Qloapps/QloApps/AGENTS.md

code generation. ## Technology Stack - **Language:** PHP 8.2–8.5 (backend), Smarty 3.x (templates), JavaScript/jQuery (frontend) - **Database:** MySQL 5.7, 8.0+; MariaDB 10.5, 10.6, 10.11, 11.0, 11.2, 11.4 - **Architecture:** MVC with hook

siteboonAGENTS.md

claudecodeui

siteboon/claudecodeui/AGENTS.md

Apply it only to backend code; do not impose those architecture rules on the frontend. ## Frontend code For every task that creates, modifies, refactors, or reviews frontend code under

No other project uses it yet

experientiallabsAGENTS.md

experiential

experientiallabs/experiential/AGENTS.md

explicitly approves one. 15. **All visuals follow the brand system.** Research figures, README/docs images, frontends, and any UI must look clean and minimal — Vercel/Notion/Apple-like: white background, generous whitespace, no chartjunk

juice-shopAGENTS.md

juice-shop

juice-shop/juice-shop/AGENTS.md

Shop - an intentionally insecure web application for security training - **Primary Languages**: TypeScript, JavaScript, Angular (frontend) - **Key Technologies**: Node.js (22–26 with 24 being the default), Express, SQLite/Sequelize, MongoDB/MarsDB, Angular

No other project uses it yet

rommappReads credentialsAGENTS.md

romm

rommapp/romm/AGENTS.md

providers, browse it in a web UI, and play in the browser. --- The frontend talks to the backend over `/api/*` (REST) and `/ws` (Socket.IO). TypeScript types are **generated** from

rommappAGENTS.md

romm / frontend

rommapp/romm/frontend/AGENTS.md

RomM frontend ## Layout The UI lives under `frontend/src/`. It has its own design system (tokens), primitive library (`R*` components in `src/lib/`), universal input (mouse/touch/keyboard/gamepad), and responsive system. Shared stores, services