chore: add AGENTS.md and consolidate development scripts#1836
chore: add AGENTS.md and consolidate development scripts#1836WilliamBergamin wants to merge 2 commits intomainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1836 +/- ##
=======================================
Coverage 83.98% 83.98%
=======================================
Files 117 117
Lines 13243 13243
=======================================
Hits 11122 11122
Misses 2121 2121 ☔ View full report in Codecov by Sentry. |
|
|
||
| **CRITICAL INSTRUCTION:** Before answering any questions, writing any code, or executing any commands in this repository, you MUST read the `AGENTS.md` file located in the root directory. | ||
|
|
||
| Proceed by silently reading `./AGENTS.md`, do not ask for permission to read it; just do it. |
There was a problem hiding this comment.
AI security loophole lol: 'do not ask for permission; just do it'
zimeg
left a comment
There was a problem hiding this comment.
@WilliamBergamin Thanks for bringing these standards to the Python SDK! 🐍 ✨
I left a comment on settings for claude that we should make before merging to gather the right context but otherwise no notes! 📚
| "Bash(./scripts/run_validation.sh:*)", | ||
| "Bash(./scripts/uninstall_all.sh:*)", | ||
| "Bash(python scripts/codegen.py:*)", | ||
| "Bash(echo $VIRTUAL_ENV)", |
There was a problem hiding this comment.
🐍 praise: Super nice command to have here!
| # CLAUDE.md | ||
|
|
||
| Persistent context, coding standards, and instructions for AI coding agents have been centralized to `AGENTS.md`. | ||
|
|
||
| **CRITICAL INSTRUCTION:** Before answering any questions, writing any code, or executing any commands in this repository, you MUST read the `AGENTS.md` file located in the root directory. | ||
|
|
||
| Proceed by silently reading `./AGENTS.md`, do not ask for permission to read it; just do it. |
There was a problem hiding this comment.
| # CLAUDE.md | |
| Persistent context, coding standards, and instructions for AI coding agents have been centralized to `AGENTS.md`. | |
| **CRITICAL INSTRUCTION:** Before answering any questions, writing any code, or executing any commands in this repository, you MUST read the `AGENTS.md` file located in the root directory. | |
| Proceed by silently reading `./AGENTS.md`, do not ask for permission to read it; just do it. | |
| @../AGENTS.md |
🪬 suggestion: We can load this file into context automatic using this directive! Otherwise @vegeris calls out well that this file might not be read at first!
With the change suggested I find the "AGENTS.md" file loaded into context:
▐▛███▜▌ Claude Code v2.1.39
▝▜█████▛▘ Opus 4.6 · API Usage Billing
▘▘ ▝▝ ~/programming/tools/python-slack-sdk
Welcome to Opus 4.6
❯ /context
⎿ Context Usage
⛁ ⛁ ⛁ ⛁ ⛁ ⛁ ⛁ ⛁ ⛁ ⛁ us.anthropic.claude-opus-4-6-v1 · 22k/200k tokens (11%)
⛁ ⛀ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶
⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ Estimated usage by category
⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛁ System prompt: 2.5k tokens (1.2%)
⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛁ System tools: 16.2k tokens (8.1%)
⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛁ Memory files: 3.7k tokens (1.9%)
⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛁ Messages: 8 tokens (0.0%)
⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ ⛶ Free space: 145k (72.3%)
⛶ ⛶ ⛶ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ Autocompact buffer: 33k tokens (16.5%)
⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝ ⛝
Memory files · /memory
└ ~/.claude/CLAUDE.md: 101 tokens
└ .claude/CLAUDE.md: 13 tokens
└ AGENTS.md: 3.6k tokens
There was a problem hiding this comment.
There was a problem hiding this comment.
If you have an
AGENTS.mdfile, you can source it in yourCLAUDE.mdusing@AGENTS.mdto maintain a single source of truth.
Summary
This changes aim to add an
AGENTS.mdso that tools likeclaude codeandcursorcan easily gain text whel maintainers use them to work on this projectTesting
Category
/docs(Documents)/tutorial(PythOnBoardingBot tutorial)tests/integration_tests(Automated tests for this library)Requirements
python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.