Skip to content

Commit 1a452bc

Browse files
mwbrooksmwbrooks
authored
docs: add AGENTS.md for coding agents (#100)
1 parent cf57dca commit 1a452bc

2 files changed

Lines changed: 21 additions & 0 deletions

File tree

‎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 generic Bolt for Python template app used to build Slack apps.
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.md‎

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

0 commit comments

Comments
 (0)