fix: attempt to improve agents.md by requesting typecheck,lint,test#1871
fix: attempt to improve agents.md by requesting typecheck,lint,test#1871
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation update to AGENTS.md that introduces a validation checklist for before declaring work complete. The sequence includes TypeScript type-checking, linting, and testing steps using specified pnpm commands. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
✨ 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 |
There was a problem hiding this comment.
Pull request overview
Updates contributor workflow guidance in AGENTS.md to encourage running local validation (typecheck/lint/tests) before marking work complete, aligning with the repo’s TypeScript + Biome + Vitest toolchain.
Changes:
- Adds a “run validation” checklist under the Workflow section.
- Recommends scoped
pnpm -F <affected-packages>runs for typecheck and tests, plus repo-wide linting.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Greptile SummaryThis PR appends a short validation checklist to the Key changes:
Minor observations:
Confidence Score: 5/5Safe to merge — documentation-only change with no code impact. The PR touches only AGENTS.md and adds a helpful validation checklist. All remaining feedback is P2 (a minor scope inconsistency in the lint step). No logic, security, or correctness issues are present. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Agent finishes changes] --> B{Affected packages identified?}
B -- Yes --> C["pnpm -F <affected-packages> typecheck"]
B -- No --> C2["pnpm typecheck (all workspaces)"]
C --> D["pnpm lint (all workspaces)"]
C2 --> D
D --> E["pnpm -F <affected-packages> test"]
E --> F{All checks pass?}
F -- Yes --> G[Declare work complete]
F -- No --> H[Fix issues and re-run]
H --> C
Reviews (1): Last reviewed commit: "fix: attempt to improve agents.md by req..." | Re-trigger Greptile |
| - Add a changeset when your PR includes a logical change that should bump versions or be communicated in release notes: https://ensnode.io/docs/contributing/prs#changesets | ||
| - Before declaring work complete, run validation in the affected packages: | ||
| 1. `pnpm -F <affected-packages> typecheck` | ||
| 2. `pnpm lint` |
There was a problem hiding this comment.
Steps 1 and 3 narrow execution to <affected-packages>, but step 2 runs pnpm lint globally across the entire monorepo. This is likely intentional (Biome linting is fast and project-wide consistency matters), but a brief note like # runs across all workspaces would help an agent understand why the scope differs and avoid silently substituting pnpm -F <affected-packages> lint.
If per-package linting is preferred for consistency, the step could instead use:
| 2. `pnpm lint` | |
| 2. `pnpm -F <affected-packages> lint` |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
self explanatory