diff --git a/.gitignore b/.gitignore index 1e111bb..1636de3 100644 --- a/.gitignore +++ b/.gitignore @@ -40,4 +40,3 @@ logs/ .vscode .cursor .claude/ -AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..8fe9cd3 --- /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 Bolt for Python template app for building search with custom functions for search and filtering. + +## 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 .`, and `pytest`. 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