-
Notifications
You must be signed in to change notification settings - Fork 168
📝 Add comprehensive AGENTS.md for Browser SDK, scripts, and E2E testing #4109
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
✅ Tests 🎉 All green!❄️ No new flaky tests detected 🎯 Code Coverage 🔗 Commit SHA: a0558de | Docs | Datadog PR Page | Was this helpful? Give us feedback! |
Bundles Sizes Evolution
🚀 CPU Performance
🧠 Memory Performance
|
|
|
||
| This project uses Yarn workspaces (v4.12.0). Never use `npm` or `npx`. | ||
|
|
||
| ## Key Commands |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO, maybe add format, lint and typecheck? To test changes is interesting to run linting and typecheck. WDYT?
BeltranBulbarellaDD
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it because it serves as internal documentation for the SDK too.
Address review feedback to include essential development commands for testing changes before committing.
Motivation
Makes working with AI a bit more efficient. Most of these instruction are things that AI can already infer, but it has to read lot of file every time so it's slow and consume lots of tokens (and it can get things wrong).
Adding AGENTS.md file help AI agents work in the repository. They were in my unstaged changes since a few days/weeks and I've found them useful. They are by no mean perfect nor complete but it's a start and we can tweak them and add more (e.g. developer extension, better unit test best practice,...) with time and experience.
AGENTS.md are compatible with Cursor and most other AI tools. Claude code read instruction from CLAUDE.md files, but can reference other file such as
@./AGENTS.md.Changes
AGENTS.md.test/e22/AGENTS.mdfor working on e2e tests.scripts/AGENTS.mdfor working on scripts.CLAUDE.mdfiles for claude code compatibility.note: I've used AI to bootstrap these files and refined them manually.
Test instructions
Testing this is probably easier on the long run. Let's merge it and give it a try, we can fix it when we find improvements.
Checklist