Skip to content

fix: attempt to improve agents.md by requesting typecheck,lint,test#1871

Merged
shrugs merged 1 commit intomainfrom
fix/agents-smoke
Apr 4, 2026
Merged

fix: attempt to improve agents.md by requesting typecheck,lint,test#1871
shrugs merged 1 commit intomainfrom
fix/agents-smoke

Conversation

@shrugs
Copy link
Copy Markdown
Collaborator

@shrugs shrugs commented Apr 4, 2026

self explanatory

@shrugs shrugs requested a review from a team as a code owner April 4, 2026 02:28
Copilot AI review requested due to automatic review settings April 4, 2026 02:28
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 4, 2026

⚠️ No Changeset found

Latest commit: c91f940

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown
Contributor

vercel bot commented Apr 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
admin.ensnode.io Building Building Preview, Comment Apr 4, 2026 2:28am
ensnode.io Building Building Preview, Comment Apr 4, 2026 2:28am
ensrainbow.io Building Building Preview, Comment Apr 4, 2026 2:28am

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 4, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 340185b2-5207-49bd-88e0-39b879f0688d

📥 Commits

Reviewing files that changed from the base of the PR and between c336c79 and c91f940.

📒 Files selected for processing (1)
  • AGENTS.md

📝 Walkthrough

Walkthrough

Documentation 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

Cohort / File(s) Summary
Workflow Documentation
AGENTS.md
Added validation steps for pre-completion checks: per-package typecheck, repo-wide lint, and per-package tests.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Add AGENTS.md #1647: Extends the same AGENTS.md file with identical "Before declaring work complete" validation sequence (typecheck, lint, tests).

Poem

🐰 A checklist hops into view,
Types check, and linters too!
Tests must pass before you're through—
The workflow's now cleaner, it's true! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/agents-smoke

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 4, 2026

Greptile Summary

This PR appends a short validation checklist to the ## Workflow section of AGENTS.md, instructing AI agents to run typecheck, lint, and test before declaring work complete. The three commands are already documented individually in the ## Commands section; this change surfaces them as an explicit, ordered pre-completion gate, which aligns well with the monorepo's pnpm-workspace conventions.

Key changes:

  • New bullet in AGENTS.md requiring agents to validate affected packages via pnpm -F <affected-packages> typecheck, pnpm lint, and pnpm -F <affected-packages> test before finishing.

Minor observations:

  • pnpm lint (step 2) is unscoped while steps 1 and 3 filter to affected packages — likely intentional for project-wide Biome consistency, but a clarifying comment would remove ambiguity for an agent.

Confidence Score: 5/5

Safe 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

Filename Overview
AGENTS.md Adds a pre-completion validation checklist (typecheck, lint, test) to the Workflow section; minor inconsistency where pnpm lint is un-filtered while the surrounding steps are scoped to affected packages.

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
Loading

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`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 pnpm lint scope inconsistency

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:

Suggested change
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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants