chore: add AGENTS.md and consolidate development scripts#1836
chore: add AGENTS.md and consolidate development scripts#1836WilliamBergamin merged 3 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. |
.claude/CLAUDE.md
Outdated
|
|
||
| **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'
There was a problem hiding this comment.
Yeah I'm not sure the do not ask for permission; just do it actually allowed it to do the thing, it just worked so I left it in 😅
But as @zimeg called out there is a better way to do this from Claude Code best practices
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!
Co-authored-by: Eden Zimbelman <eden.zimbelman@salesforce.com>
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.