-
Notifications
You must be signed in to change notification settings - Fork 3
Add agents file #450
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
Add agents file #450
Conversation
✅ Deploy Preview for pvm-debugger ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis change adds AGENTS.md, a new documentation file establishing repository guidelines. It covers project structure, build/test/dev commands, coding style, testing guidelines, and commit/PR practices for a React/TypeScript project. No functional code changes are introduced. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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.
Actionable comments posted: 1
🧹 Nitpick comments (2)
AGENTS.md (2)
4-4: Consider breaking down the dense Project Structure section for readability.Line 4 packs multiple topics (directories, WASM workers, RPC alignment, asset locations, test placement, tsconfig updates) into a single paragraph. While accurate, restructuring this as a bulleted list or separate subsections could improve clarity for new contributors scanning the guidelines.
## Project Structure & Module Organization - **React app**: `src/` holds reusable UI in `components/`, feature views in `pages/`, Redux logic in `store/`, and shared helpers in `hooks/` and `lib/`. - **Web workers**: WASM-facing workers live in `src/packages/web-worker`; keep their RPC shapes aligned with the integrations listed in `README.md`. - **Static assets & build outputs**: `public/` for static files, `dist/` for build outputs. - **Testing**: Browser specs and fixtures belong in `tests/`; unit specs stay beside their modules using the `*.spec.ts(x)` suffix. - **Configuration**: Add any new top-level folder to the `@/` alias in `tsconfig.json`.
7-7: Node version specification could become stale; ensure it's kept in sync with tooling requirements.The reference to "Node 22.1.0 expected" is specific and helpful for reproducibility, but pinned versions can quickly become outdated as dependencies update. Consider verifying this matches what's specified in
package.json(engines field) or.nvmrc, and document a process for keeping this guideline synchronized during tool upgrades.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
AGENTS.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
No description provided.