AGENTS.md examples from real projects

gogsAGENTS.md

gogs

gogs/gogs/AGENTS.md

Style and mechanics This applies to all texts, including but not limited to UI, documentation, code comments. - Use sentence case. Preserve original casing for brand names. - End with a period

No other project uses it yet

prismaAGENTS.md

orm

prisma/orm/AGENTS.md

table properties. ### Package Organization Organized by **Domains → Layers → Planes**: - **Domains**: Framework (target-agnostic), SQL, Document, Targets, Extensions - **Layers**: Core → Authoring → Tooling → Lanes → Runtime → Adapters - **Planes**: Migration, Runtime, Shared See `architecture.config.json

apacheAGENTS.md

airflow

apache/airflow/AGENTS.md

monorepo with only dependencies that it has ## Security Model When reviewing code, writing security documentation, or performing security research, keep in mind the following aspects of Airflow's security model

apacheReads credentialsAGENTS.md

airflow / dev

apache/airflow/dev/AGENTS.md

keep the `requires-python` line. Run scripts with: ```shell uv run dev/my_script.py [args...] ``` Document `uv run` (not `python`) as the invocation method in READMEs and instructions. ## Fork CI job statuses

apacheAGENTS.md

airflow / providers

apache/airflow/providers/AGENTS.md

Agent Instructions Each provider is an independent package with its own `pyproject.toml`, tests, and documentation. ## Structure - `provider.yaml` — metadata, dependencies, and configuration for the provider. - Building blocks: Hooks, Operators, Sensors, Transfers

No other project uses it yet

apacheAGENTS.md

airflow / registry

apache/airflow/registry/AGENTS.md

Agent Guidelines for Airflow Registry This document contains rules, patterns, and guidelines for working on the Airflow Registry project. ## Core Principles ### 0. Minimal JavaScript - Keep JavaScript to minimum necessary - Theme

ogulcancelikAGENTS.md

herdr

ogulcancelik/herdr/AGENTS.md

opening a pull request instead of pushing `master` directly. Small, low-risk changes and documentation-only updates can use a lighter workflow when Can prefers it. Immediately before opening

siyuan-noteAGENTS.md

siyuan

siyuan-note/siyuan/AGENTS.md

consistent with existing practices and compatibility requirements. Consider whether an existing capability or a documentation correction already satisfies the need, including the option of making no code change. Compare user

serverlessReads credentialsAGENTS.md

serverless

serverless/serverless/AGENTS.md

Runtime API bridge + exec wrapper for the Dev Mode layer ├── docs/sf/ # User-facing documentation (published to serverless.com) ├── skills/ # Agent Skills shipped inside the CLI (CI-linted) └── release-scripts/ # Release automation

cliAGENTS.md

cli

cli/cli/AGENTS.md

narration of the code. - Use ordinary hyphens, not em dashes, in code, comments, and documentation. Before preparing or updating a PR, read the [PR template](.github/PULL_REQUEST_TEMPLATE.md) fresh. Keep its headings

No other project uses it yet

DIYgodAGENTS.md

RSSHub

DIYgod/RSSHub/AGENTS.md

fallback for `pubDate`. If no date is available, leave it undefined. See [No Date documentation](https://docs.rsshub.app/joinus/advanced/pub-date#no-date). 22. **No Title Trimming**: Do not manually trim or truncate titles. RSSHub

No other project uses it yet

danny-avilaAGENTS.md

LibreChat

danny-avila/LibreChat/AGENTS.md

common case. Database contracts belong to `packages/data-schemas`. Keep Mongoose types (`FilterQuery`, `Types.ObjectId`, `Document`) out of exported signatures in `packages/api`, `packages/data-provider` and `client`, because they make the storage engine part

files-communityAGENTS.md

Files

files-community/Files/AGENTS.md

safe and are not acceptable exemptions. - Keep suppressions of trimming or AOT diagnostics local, document why the reflected members remain available, and verify the relevant AOT build. ### WinRT server

streamlitAGENTS.md

streamlit

streamlit/streamlit/AGENTS.md

tech specs for Streamlit features. - `.github/workflows/`: GitHub Actions workflows used for CI/CD. - `wiki/`: Documentation relevant for development of Streamlit. ## Shell & Build Policy - Prefer `make` targets for all dev tasks (tests

streamlitAGENTS.md

streamlit / skills

streamlit/streamlit/.claude/skills/AGENTS.md

SKILL.md # Required: Instructions for the AI agent ├── scripts/ # Optional: Executable code ├── references/ # Optional: Additional documentation └── assets/ # Optional: Static resources ``` ### SKILL.md format The `SKILL.md` file must include YAML frontmatter and markdown

streamlitAGENTS.md

streamlit / frontend

streamlit/streamlit/frontend/AGENTS.md

name collides with a local or DOM name. - **Prefer JSDoc over regular comments**: When documenting functions, types, interfaces, classes, or their members, use JSDoc (`/** ... */`) instead of regular comments (`//` or `/* */`). JSDoc

No other project uses it yet

streamlitReads credentialsAGENTS.md

streamlit / workflows

streamlit/streamlit/.github/workflows/AGENTS.md

Streamlit repository. Workflows automate CI/CD, testing, releases, and maintenance tasks. > **Maintenance Note:** Keep this documentation up to date. When adding, removing, or modifying workflows or composite actions, update the relevant

streamlitAGENTS.md

streamlit / specs

streamlit/streamlit/specs/AGENTS.md

product specs - `YYYY-MM-DD-template/tech-spec.md` — Template for tech specs - `README.md` — Full process documentation ## When to Write a Spec **Product spec** — focuses on _what_ and _why_: user-facing problem

basecampReads credentialsAGENTS.md

omarchy

basecamp/omarchy/AGENTS.md

visual effect in the running UI - [`agents/skills/migrations.md`](agents/skills/migrations.md) - creating or changing migrations under `migrations/` # Documentation Layout Three documentation trees, split by genre and audience: - `agents/skills/` - task procedure ("do this when

SentryAGENTS.md

sentry / src

getsentry/sentry/src/AGENTS.md

review`** and **`sentry-security`** skills. ## Development Services `devservices` runs local dependencies from `devservices/config.yml`. Full documentation: https://develop.sentry.dev/development-infrastructure/devservices/ ## AI Assistant Quick Decision Trees ### "User wants to add an API endpoint