AGENTS.md examples from real projects

apacheAGENTS.md

echarts

apache/echarts/AGENTS.md

Docs When a task touches contribution workflow, prefer the repo's own contributor-facing documents over this summary: - `CONTRIBUTING.md` for general contribution guidance - `https://github.com/apache/echarts/wiki/How-to-make-a-pull-request` for PR workflow, test

No other project uses it yet

xtekkyReads credentialsAGENTS.md

gpt4free

xtekky/gpt4free/AGENTS.md

sandbox that unifies access to many LLM and media providers. The public site and documentation live at <https://g4f.dev> (source: `gpt4free/g4f.dev`). The pipeline is designed to work on both workspaces

prometheusAGENTS.md

prometheus

prometheus/prometheus/AGENTS.md

Agents Guide for Prometheus This document captures patterns and preferences observed from maintainer reviews of recently merged pull requests. Use it to align your contributions with what maintainers expect

No other project uses it yet

facebookAGENTS.md

docusaurus

facebook/docusaurus/AGENTS.md

AGENTS.md ## Docusaurus Overview: - Modern static site generator framework - SPA - Focus on documentation sites - Built with React - Supports MDX, i18n, versioning - Extensive plugin architecture - Uses itself to build its own sites

mvanhornReads credentialsAGENTS.md

last30days-skill

mvanhorn/last30days-skill/AGENTS.md

main research engine - `skills/last30days/scripts/lib/` — search, enrichment, rendering modules - `skills/last30days/scripts/lib/vendor/bird-search/` — vendored X search client - `docs/solutions/` — documented solutions to past problems (bugs, best practices, workflow patterns), organized by category with YAML frontmatter

No other project uses it yet

webpackAGENTS.md

webpack

webpack/webpack/AGENTS.md

fits, add a directory, with its bullet in the map, in the same commit. - **Documentation lives in `docs/`**, never under `lib/`, which is published (`package.json` `files`); docs about `test

warpdotdevAGENTS.md

Warp

warpdotdev/Warp/AGENTS.md

driven implementation, this section replaces the broader pre-push presubmit guidance in `CONTRIBUTING.md`; that document still describes the human contributor workflow. A later source, test, manifest, generated-code, or configuration

coollabsioReads credentialsAGENTS.md

coolify

coollabsio/coolify/AGENTS.md

build`, `npm run dev`, or `composer run dev`. Ask them. ## Documentation Files - You must only create documentation files if explicitly requested by the user. ## Replies - Be concise in your explanations

traefikAGENTS.md

traefik

traefik/traefik/AGENTS.md

edited. - `integration/` — integration tests; reusable fixtures under `integration/fixtures/`. - `docs/content/` — MkDocs sources for the public documentation. ## Before you edit Read two or three existing files in the same package before adding

No other project uses it yet

scrapyAGENTS.md

scrapy

scrapy/scrapy/AGENTS.md

attributes with `_` unless users must call them by name. Do not re-export or document private APIs. - Write comments for a reader who has never seen the code any other

No other project uses it yet

2dustAGENTS.md

v2rayNG

2dust/v2rayNG/AGENTS.md

Store debug variant unless task scope names another distribution. Apply every matching validation rule: - Documentation only: run `git diff --check`; no Gradle task is required. - Kotlin/Java production code

No other project uses it yet

usememosAGENTS.md

memos

usememos/memos/AGENTS.md

server/api/acl_config.go`. - Ask before adding heavy dependencies, changing auth/token behavior, or altering Docker/release workflows. ## Documentation - ADRs and their companion glossary have been retired. Do not recreate them unless explicitly requested. - Design

gitAGENTS.md

git / po

git/git/po/AGENTS.md

successful l10n teams work well without it. The section "Housekeeping tasks for localization workflows" documents the most commonly used housekeeping tasks: 1. Generating or updating po/git.pot 2. Updating po/XX.po

withastroAGENTS.md

astro

withastro/astro/AGENTS.md

workaround to the GitHub issue or PR that motivates it. - When your change alters documented behavior, extend or correct the existing prose — never replace specific docs with generic text. - Exception

No other project uses it yet

bladerAGENTS.md

humanizer

blader/humanizer/AGENTS.md

list`, and `claude plugin validate .`. ## Writing style Use Plain Language in code comments, prompts, documentation, descriptions, validation messages, and progress reports. - Lead with the main point. - Use common words

ultralyticsAGENTS.md

ultralytics

ultralytics/ultralytics/AGENTS.md

code in this repository. CLAUDE.md is a symlink to this file. `docs/AGENTS.md` covers the documentation tree; read it whenever a change touches a public Python API, because docs reference pages

No other project uses it yet

hugohe3AGENTS.md

ppt-master

hugohe3/ppt-master/AGENTS.md

Generate PPTX, Create Template, and Edit Native PPTX. Child workflows, profiles, stages, and governance documents refine one selected route; they are not competing top-level routes. - Topic-only or fact

No other project uses it yet

tw93AGENTS.md

Pake

tw93/Pake/AGENTS.md

configuration (gitignored) ├── .agents/skills/ # Agent skills (/release); .claude/skills/* symlinks here ├── dist/ # Compiled CLI output ├── docs/ # Documentation │ ├── cli-usage.md # CLI parameters │ ├── advanced-usage.md # Customization guide │ └── faq.md # Troubleshooting ├── gallery/ # Site recipes for the Pake apps

rcloneAGENTS.md

rclone

rclone/rclone/AGENTS.md

tense statement of what it is or does (`// Mkdir makes the directory (container, bucket)`) **Document the contract** callers need - preconditions, what's returned, which sentinel errors are returned and when

No other project uses it yet

pingchesuAGENTS.md

gsd-hermes

pingchesu/gsd-hermes/docs/AGENTS.md

ARCHITECTURE.md`, `PITFALLS.md` | **Capabilities:** - Web search for current ecosystem information - Context7 MCP integration for library documentation - Writes research documents directly to disk (reduces orchestrator context load) --- ### gsd-phase-researcher **Role:** Researches