Skip to content

Commit 58aa95d

Browse files
authored
docs: add AGENTS.md for coding agents (#259)
1 parent 2f5afe9 commit 58aa95d

12 files changed

Lines changed: 81 additions & 120 deletions

File tree

‎.claude/CLAUDE.md‎

Lines changed: 0 additions & 75 deletions
This file was deleted.

‎AGENTS.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# AGENTS.md
2+
3+
This file provides guidance to coding agents when working with code in this repository.
4+
5+
## What This Is
6+
7+
A monorepo with three functionally identical implementations of the Starter Agent for Slack built with Bolt for Python, each self-contained with its own `AGENTS.md`:
8+
9+
- `claude-agent-sdk/`: Claude Agent SDK
10+
- `openai-agents-sdk/`: OpenAI Agents SDK
11+
- `pydantic-ai/`: Pydantic AI
12+
13+
Work and run commands inside one of them. Keep the three in parity: a user-facing change to one usually belongs in the others.
14+
15+
## Slack Plugin
16+
17+
To install the Slack plugin for your coding agent, follow [Claude Code, Codex, Cursor, and Other Coding Agents](./README.md#claude-code-codex-cursor-and-other-coding-agents) in the README.

‎CLAUDE.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

‎claude-agent-sdk/.claude/CLAUDE.md‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎claude-agent-sdk/AGENTS.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# AGENTS.md
2+
3+
This file provides guidance to coding agents when working with code in this repository.
4+
5+
## What This Is
6+
7+
A **Starter Agent** for Slack built with Bolt for Python and the **Claude Agent SDK**. This is a minimal starter template. It includes one example tool (emoji reactions) and optional Slack MCP Server integration.
8+
9+
## Slack Plugin
10+
11+
To install the Slack plugin for your coding agent, follow [Claude Code, Codex, Cursor, and Other Coding Agents](./README.md#claude-code-codex-cursor-and-other-coding-agents) in the README.
12+
13+
## Before you finish
14+
15+
Run `ruff check .`, `ruff format --check .`, and `pytest`. CI runs the same on every PR.
16+
17+
## Code Style
18+
19+
- Snake-case filenames
20+
- No code comments. Make the code explain itself with clear names, tests, or types. Put the reason for a change in the PR description.

‎claude-agent-sdk/CLAUDE.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

‎openai-agents-sdk/.claude/CLAUDE.md‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎openai-agents-sdk/AGENTS.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# AGENTS.md
2+
3+
This file provides guidance to coding agents when working with code in this repository.
4+
5+
## What This Is
6+
7+
A **Starter Agent** for Slack built with Bolt for Python and the **OpenAI Agents SDK**. This is a minimal starter template. It includes one example tool (emoji reactions) and optional Slack MCP Server integration.
8+
9+
## Slack Plugin
10+
11+
To install the Slack plugin for your coding agent, follow [Claude Code, Codex, Cursor, and Other Coding Agents](./README.md#claude-code-codex-cursor-and-other-coding-agents) in the README.
12+
13+
## Before you finish
14+
15+
Run `ruff check .`, `ruff format --check .`, and `pytest`. CI runs the same on every PR.
16+
17+
## Code Style
18+
19+
- Snake-case filenames
20+
- No code comments. Make the code explain itself with clear names, tests, or types. Put the reason for a change in the PR description.

‎openai-agents-sdk/CLAUDE.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

‎pydantic-ai/.claude/CLAUDE.md‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)