Skip to content

docs: add typecheck target to AGENTS.md local affected command - #135

Open
detail-app[bot] wants to merge 1 commit into
mainfrom
detail/fix-docs/docs-add-typecheck-target-to-agents-md-local-affec-5cc934
Open

detail-app[bot] wants to merge 1 commit into
mainfrom
detail/fix-docs/docs-add-typecheck-target-to-agents-md-local-affec-5cc934

Conversation

@detail-app

@detail-app detail-app Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

The local pre-push command in AGENTS.md listed "pnpm nx affected -t lint test build", but CI (since the typecheck target was added via @nx/js/typescript plugin and "chore(ci): do typecheck on ci") now runs "pnpm exec nx affected -t lint typecheck test build". The doc command was missing the new "typecheck" target, so a contributor copying it would push a PR that fails the very CI check the doc is meant to mirror and have no local signal as to why.

Introduced by commit 8578893 (@fwal, #133)


Doc Drift PRs can be configured here.

@detail-app
detail-app Bot requested a review from fwal as a code owner September 23, 2026 17:36
@github-actions github-actions Bot added 📖 docs Improvements or additions to documentation 🐛 fix Something is broken or doesn't work properly labels Sep 23, 2026
@greptile-apps

greptile-apps Bot commented Sep 23, 2026

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

This docs-only change appears safe to merge.

What we checked:

  • Local check could differ from CI: Yes. Both commands run lint, typecheck, test, and build. The Nx setup also defines typecheck.
Summary

AGENTS.md now tells contributors to run type checks with the local affected command, matching the checks already run in CI.

  • Adds the typecheck target to the documented Nx command.
Diagram
sequenceDiagram
    actor Contributor
    participant pnpm
    participant Nx
    Contributor->>pnpm: pnpm nx affected -t lint typecheck test build
    pnpm->>Nx: Start the affected command
    Nx->>Nx: Find affected projects
    Nx->>Nx: Schedule lint, typecheck, test, and build
    Nx-->>Contributor: Return the combined result
Loading

Reviews (1) · Last reviewed commit: "docs: add typecheck target to AGENTS.md ..."

This branch has not been deployed

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

Labels

📖 docs Improvements or additions to documentation 🐛 fix Something is broken or doesn't work properly

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant