Skip to content

docs(claude): fix build/test commands and file layout in CLAUDE.md#1243

Open
cristim wants to merge 1 commit into
mainfrom
docs/hyg-10-fix
Open

docs(claude): fix build/test commands and file layout in CLAUDE.md#1243
cristim wants to merge 1 commit into
mainfrom
docs/hyg-10-fix

Conversation

@cristim

@cristim cristim commented Jun 11, 2026

Copy link
Copy Markdown
Member

Problem

CLAUDE.md, the highest-priority instruction file for every agent session, contained two factually wrong sections (review finding HYG-10):

  • Build & Test instructed npm run build / npm test / npm run lint at the repo root, where no package.json exists; the root build is Go.
  • File Organization mandated /src, /tests (as generic test dir), /config, /examples directories that do not exist; the real layout is cmd/, internal/, pkg/, providers/, frontend/, terraform/, etc.

Fix

Replaced only the factual errors, preserving the rest of the file:

  • Build & Test now documents the real commands: go build ./... / go test ./... at the root (with the make build / make test-unit / make lint equivalents), and the npm scripts (npm run build, npm test, npm run lint) under frontend/.
  • File Organization now describes the actual directory map: cmd/, internal/, pkg/, providers/, frontend/, terraform//cloudformation//arm//iac/, docs/, scripts/, tests/ (e2e).

No other sections were changed.

Verification

  • Every documented command cross-checked against Makefile targets (build, test-unit, lint exist and run go build/go test/golangci-lint) and frontend/package.json scripts (build, test, lint exist).
  • Directory list cross-checked against the actual repo root and internal/ contents.
  • go build ./... run successfully at the repo root of this branch.

Closes #1179

@cristim cristim added triaged Item has been triaged priority/p3 Polish / idea / may never ship severity/low Minor harm urgency/eventually No deadline impact/internal Team-internal only effort/s Hours type/docs Documentation labels Jun 11, 2026
@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 12 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: de3f4eaa-72b0-4c78-8fbd-f92f415dd7b9

📥 Commits

Reviewing files that changed from the base of the PR and between 1d9f1b8 and 402c2de.

📒 Files selected for processing (1)
  • CLAUDE.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/hyg-10-fix

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

@cristim

cristim commented Jun 11, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@cristim

cristim commented Jun 19, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

The Build & Test section instructed npm run build / npm test / npm run
lint at the repo root, where no package.json exists; the root build is
Go. The File Organization section mandated /src, /tests, /config,
/examples directories that do not exist in this repo.

Replace both sections with the real commands (go build ./... and
go test ./... at the root, make build / make test-unit / make lint,
npm scripts under frontend/) and the actual directory layout (cmd/,
internal/, pkg/, providers/, frontend/, terraform/, docs/, scripts/,
tests/). All documented commands verified against the Makefile and
frontend/package.json; go build ./... run successfully at the root.
No other sections changed.

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

Labels

effort/s Hours impact/internal Team-internal only priority/p3 Polish / idea / may never ship severity/low Minor harm triaged Item has been triaged type/docs Documentation urgency/eventually No deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

HYG-10: Repo CLAUDE.md gives wrong build/test commands (npm at root) and a file layout that does not match the repo

1 participant