Skip to content

docs: Update AGENTS.md #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 5, 2025
Merged

docs: Update AGENTS.md #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AGENTS.md

This file is for code-writing LLM agents like Claude Code, Gemini CLI, Cursor, etc.
This file contains instructions for code-writing LLM agents like Claude Code, Gemini CLI, Cursor, OpenAI Codex, etc.

CLAUDE.md symlinks to this file.

Expand All @@ -19,4 +19,17 @@ Use the `scripts/` directory to run scripts:
- `scripts/lint` - Run linting checks (ruff + pyright + mypy) and import verification
- `scripts/format` - Run code formatting (ruff format + doc formatting)
- `scripts/test` - Run full test suite (includes Prism mock server setup and Pydantic v1 compatibility tests)
- `scripts/mock` - Start Prism mock server for testing
- `scripts/mock` - Start Prism mock server for testing


## Branches and Pull Requests

When opening a pull request, target the `next` branch.

The `main` branch reflects code that has been released to the package manager whereas the next branch queues up unreleased changes for you to review via the release PR.


## More information

Read the CONTRIBUTING.md file in this repository for more information.