chore: add AGENTS.md for AI-assisted development#114
Conversation
Document key commands, tech stack, and code style conventions.
📝 WalkthroughWalkthroughA new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
❌MegaLinter analysis: Error
Detailed Issues❌ REPOSITORY / osv-scanner - 22 errorsSee detailed reports in MegaLinter artifacts
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Around line 16-24: The docs show npm commands but the repo standard is pnpm
10+; update the example commands in AGENTS.md by replacing the three occurrences
of "npm run build", "npm run test:all", and "npm run lint" with the pnpm
equivalents "pnpm build", "pnpm test:all", and "pnpm lint" (or explicitly note
both npm/pnpm are supported), ensuring the displayed bash snippet and any
related README examples use pnpm to match the declared package manager.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ```bash | ||
| # Build all packages | ||
| npm run build | ||
|
|
||
| # Run tests | ||
| npm run test:all | ||
|
|
||
| # Lint | ||
| npm run lint |
There was a problem hiding this comment.
Unify package-manager commands with stated pnpm standard.
You declare pnpm 10+ as the package manager, but examples use npm run .... Please switch examples to pnpm (or explicitly state both are supported) to avoid agent/tooling drift. Based on learnings: Use pnpm 10+ as the package manager.
Suggested doc fix
```bash
# Build all packages
-npm run build
+pnpm build
# Run tests
-npm run test:all
+pnpm test:all
# Lint
-npm run lint
+pnpm lint</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against the current code and only fix it if needed.
In @AGENTS.md around lines 16 - 24, The docs show npm commands but the repo
standard is pnpm 10+; update the example commands in AGENTS.md by replacing the
three occurrences of "npm run build", "npm run test:all", and "npm run lint"
with the pnpm equivalents "pnpm build", "pnpm test:all", and "pnpm lint" (or
explicitly note both npm/pnpm are supported), ensuring the displayed bash
snippet and any related README examples use pnpm to match the declared package
manager.
</details>
<!-- fingerprinting:phantom:triton:hawk:2503cc1a-0ea4-49ce-80f9-d81b68fdea22 -->
<!-- This is an auto-generated comment by CodeRabbit -->
1 participant
Document key commands, tech stack, and code style conventions for AI development tools.
Summary by CodeRabbit