From 03795fc260c92b38d98eecfaeabc4263606d567e Mon Sep 17 00:00:00 2001 From: Michael Brooks Date: Fri, 23 Oct 2026 13:58:31 -0600 Subject: [PATCH] docs: add AGENTS.md for coding agents --- AGENTS.md | 20 ++++++++++++++++++++ CLAUDE.md | 1 + 2 files changed, 21 insertions(+) create mode 100644 AGENTS.md create mode 100644 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..a2c0846 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,20 @@ +# AGENTS.md + +This file provides guidance to coding agents when working with code in this repository. + +## What This Is + +A collection of small Slack apps built with Bolt for Python, each showing one feature. Each example lives in its own folder with its own dependencies. + +## Slack Plugin + +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. + +## Before you finish + +Run `ruff check .`, `ruff format --check .`, `mypy .`, and `pytest` inside the example you changed. CI runs the same on every PR. + +## Code Style + +- Snake-case filenames +- No code comments. Make the code explain itself with clear names, tests, or types. Put the reason for a change in the PR description. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..43c994c --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md