AGENTS.md examples from real projects

storytoldAGENTS.md

artcraft / crates

storytold/artcraft/crates/AGENTS.md

Rust version; use latest stable features freely - Never use `println!` or `eprintln!` outside of tests; use `log` crate macros instead - Use `anyhow::Result` / `AnyhowResult` for fallible functions in application code

No other project uses it yet

QuivrHQAGENTS.md

quivr

QuivrHQ/quivr/AGENTS.md

accounts, volumes, configurations, meeting notes or quotes from private tickets. That applies to code, tests, fixtures, docs, comments, commit messages and pull-request text. Write features and docs

QuivrHQAGENTS.md

quivr / quivr-search

QuivrHQ/quivr/quivr-search/AGENTS.md

Demo test ownership Follow the [testing standard](../docs/agents/testing.md) before changing tests. - Facet rules belong in `tests/explore.test.mjs` through `createExplorer().facets`; supply raw engine answers and literal corpus schemas at its upstream

QuivrHQAGENTS.md

quivr / sdks

QuivrHQ/quivr/sdks/AGENTS.md

test ownership - Request-token verification belongs to the normative [authentication cases](../contracts/plugins/v0/fixtures/authentication/cases.json), executed against both SDKs by [the shared conformance script](../scripts/plugin_sdk_conformance.py). Add cases there and prove each verifier guard

mattermostAGENTS.md

mattermost

mattermost/mattermost/AGENTS.md

AGENTS.md Explicitly import subdirectory instruction files that must always be in context: @server/AGENTS.md @e2e-tests/playwright/AGENTS.md ## Pull Requests When creating a pull request, follow `.github/PULL_REQUEST_TEMPLATE.md` exactly: - Remove all ` ` comments. - Omit

mattermostAGENTS.md

mattermost / webapp

mattermost/mattermost/webapp/AGENTS.md

coding agents working inside `webapp/`. ## Coding Standards Follow `webapp/STYLE_GUIDE.md` for canonical style, accessibility, and testing standards. ## UI components (Compass) - **Catalog / APIs**: inspect `@mattermost/compass-ui` (package exports / component types) before inventing

spacedriveappAGENTS.md

spacedrive

spacedriveapp/spacedrive/AGENTS.md

Start daemon: `cargo run --bin sd-daemon` 2. Make code changes 3. Run tests: `cargo test` 4. Rebuild and restart: `cargo run --bin sd-cli -- restart` 5. Test

spacedriveappAGENTS.md

spacedrive / core

spacedriveapp/spacedrive/core/AGENTS.md

AGENTS.md - Spacedrive Core v2 ## Build/Test Commands - `cargo build` - Build the project - `cargo test` - Run all tests - `cargo test ` - Run specific test (e.g., `cargo test library_test`) - `cargo clippy` - Lint code

rapid7AGENTS.md

metasploit-framework

rapid7/metasploit-framework/AGENTS.md

written for human contributors. ## Project Overview Metasploit Framework is an open-source penetration testing and exploitation framework written in Ruby. It provides infrastructure for developing, testing, and executing exploit code

RSSNextAGENTS.md

Folo

RSSNext/Folo/AGENTS.md

required) pnpm run typecheck # 2) Lint and auto-fix pnpm run lint:fix # 3) Tests pnpm run test ``` - Run the above at the root, or use per-package variants

No other project uses it yet

chatwootAGENTS.md

chatwoot

chatwoot/chatwoot/AGENTS.md

nested `AGENTS.md` files only for subtree-specific differences; avoid duplicating root rules. ## Build, Test, and Lint - **Ruby setup**: Use the version in `.ruby-version` through `rbenv`. Before Ruby commands

No other project uses it yet

ueberdosisAGENTS.md

tiptap

ueberdosis/tiptap/AGENTS.md

demos/` is a Vite app used as playground and as the target for e2e tests. All scripts are in the root `package.json`. ## Rules - Small, single-purpose diffs. Ask the user

AlexsJonesAGENTS.md

llmfit

AlexsJones/llmfit/AGENTS.md

llama.cpp, Docker Model Runner, LM Studio, vLLM, and RamaLama. - `quality.rs`: Runs response quality tests. It scores roles, builds routing recommendations, and compares results with baselines. - `share.rs`: Stores local benchmark results

No other project uses it yet

directusAGENTS.md

directus

directus/directus/AGENTS.md

formatting pnpm lint # ESLint pnpm lint:style # Stylelint for CSS/SCSS/Vue pnpm format # Prettier check # Testing pnpm test # Run all unit tests pnpm --filter @directus/api test # Test specific package

No other project uses it yet

DockerAGENTS.md

compose

docker/compose/AGENTS.md

AI_POLICY.md](AI_POLICY.md) and the Compose-specific rules in [CONTRIBUTING.md](CONTRIBUTING.md#ai-assisted-contributions). ## Build & Test - Build: `make build` - Test all: `make test` - Test unit: `go test ./pkg/...` — needs no Docker

sgl-projectAGENTS.md

sglang

sgl-project/sglang/docs/AGENTS.md

Build and maintain the SGLang documentation site and integrated cookbook using Mintlify. Use when

CopilotKitAGENTS.md

CopilotKit

CopilotKit/CopilotKit/AGENTS.md

General Guidelines for working with Nx - When running tasks (for example build, lint, test, e2e, etc.), always prefer running the task through `nx` (i.e. `nx run`, `nx run-many

No other project uses it yet

CopilotKitAGENTS.md

CopilotKit / showcase

CopilotKit/CopilotKit/showcase/AGENTS.md

Showcase — Agent Guidance (canonical) > **BEFORE touching ANY showcase cell (integration, test, fixture, frontend), these are non-negotiable.** > > These rules have been re-explained ~20 times because they were written down

No other project uses it yet

vlangAGENTS.md

v

vlang/v/AGENTS.md

Divergences From Repo Docs * Quick Decisions * Common Workflow * Reporting * Prerequisites * Build & Rebuild * Run Programs * Testing * Code Style * Modules and Imports * C/JS Interop Hygiene * Environment-Specific Code (files and `$if`) * Compile

No other project uses it yet

keycloakAGENTS.md

keycloak

keycloak/keycloak/AGENTS.md

problem, not the solution. * For enhancement requests, describe the proposed change. Issues for flaky tests get the `flaky-test` label and issues for flaky CI jobs get the `flaky