Skip to content

docs: add CLAUDE.md with build, test, lint and format commands - #833

Merged
Brooooooklyn merged 2 commits into
mainfrom
claude/improve-claude-md-2026-10-13
Oct 14, 2026
Merged

Brooooooklyn merged 2 commits into
mainfrom
claude/improve-claude-md-2026-10-13

Conversation

@Brooooooklyn

@Brooooooklyn Brooooooklyn commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

Requested by Brooklyn · project thread

7 agent-authored PRs read · window searched: 2026-10-04 to 2026-10-11; the PRs read span 2026-10-09 to 2026-10-10 (2 days) · 0 helpers started. The PRs are a sample: agent PRs found by claude/ head branch or the Claude Code footer in the body, then every review comment on each.

Before: this repository has no CLAUDE.md. Claude Code reads CLAUDE.md files, so an agent session here starts without the repository's build, test, lint and format commands.

After: a short root CLAUDE.md lists those commands. Every line names a command that the repository's own justfile, package.json or CI workflow defines, and package.json scripts are run through vp run, as AGENTS.md requires.

No rule edits: review comments were fixed on two PRs, but each had a different cause, so no cause repeated across two PRs.

Checked in the repository, not tested

Line Proof on main
just build (core binding, oxc runtime, CLI) justfile build recipe
vp run test package.json test script; AGENTS.md "Built-in Commands vs Scripts"
just ready justfile ready recipe
cargo test --all-features .github/workflows/CI.yml line 50
vp run lint package.json lint script
cargo clippy --all-targets --all-features -- -D warnings .github/workflows/CI.yml line 48
vp run fmt package.json fmt script

Checks

  • Ran prettier --check CLAUDE.md (passes) and git diff --check (clean).
  • Could not run the repository's own formatter (vp run fmt) or a spell checker: they are not installed in this environment, and installing dependencies was out of scope.
  • The added file is the whole diff.
  • Review follow-up (e312900): switched scripts to vp run and the build step to just build, so the integration tests find packages/cli/dist/index.js on a clean checkout.

🤖 Generated with Claude Code

https://claude.ai/code/session_01XqXJZrD5seBTKh2qyvNuk9

To revert, revert this PR's commits, or delete CLAUDE.md.


Generated by Claude Code

Claude Code loads CLAUDE.md, not AGENTS.md, so agents in this
repository start without the commands they need to verify a change.
Each line names a command defined in the repository's own scripts.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XqXJZrD5seBTKh2qyvNuk9
@Brooooooklyn Brooooooklyn self-assigned this Oct 13, 2026
@Brooooooklyn
Brooooooklyn marked this pull request as ready for review October 13, 2026 15:50
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-14T03:03:58.837677Z e312900 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0610af8c19

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread CLAUDE.md Resolved
Comment thread CLAUDE.md Resolved
Addresses review: package.json scripts go through `vp run` per AGENTS.md,
and the build step is `just build`, which also builds the CLI that the
integration tests execute.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AuuWzg89GTrDshczyVbueh
@Brooooooklyn
Brooooooklyn merged commit 4ae5186 into main Oct 14, 2026
67 checks passed
@Brooooooklyn
Brooooooklyn deleted the claude/improve-claude-md-2026-10-13 branch October 14, 2026 03:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants