Skip to content

Update CLAUDE.md with build/test commands and doc clarifications - #9

Draft
thetigerone888 wants to merge 1 commit into
mainfrom
claude/claude-md-docs-ehce3s
Draft

Update CLAUDE.md with build/test commands and doc clarifications#9
thetigerone888 wants to merge 1 commit into
mainfrom
claude/claude-md-docs-ehce3s

Conversation

@thetigerone888

@thetigerone888 thetigerone888 commented Jul 20, 2026

Copy link
Copy Markdown
Owner

Summary

Reviewed the existing CLAUDE.md against the current state of the repository. Its core content (architecture notes, directory map, conventions) was verified accurate, so this PR makes only targeted additions:

  • Commands: added pnpm build:web (static web export used by the Vercel deploy), pnpm build && pnpm start (server production bundle), and pnpm qr to the development workflow list.
  • Single-test invocation: documented how to run one test file (pnpm test tests/analytics.test.ts) or tests by name (pnpm vitest run -t "calculateNPS"). Verified the file-level command passes (21/21 tests).
  • README clarification: noted that the root README.md is a duplicate of server/README.md (the backend guide), not a project overview, so future readers don't get misled.
  • CI note: flagged that .github/workflows/ contains stock GitHub-suggested workflows (CodeQL, stale bot, Jekyll Pages, npm-publish samples) not tailored to this pnpm/Expo project.
  • Aligned the header line with the standard Claude Code phrasing.

Verification

  • Confirmed the "entirely client-side" architectural note still holds (server/routers.ts has only system/auth routers; drizzle/schema.ts has only users).
  • Confirmed deploy-related notes match current DEPLOY.md/metro.config.js after the recent forceWriteFileSystem change.
  • Ran pnpm test tests/analytics.test.ts — all 21 tests pass.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WE4dzSSfapDKjt5xACz9pd


Generated by Claude Code

Summary by Sourcery

Update CLAUDE.md with additional project guidance and development workflow details.

Documentation:

  • Clarify CLAUDE.md header description and its role for Claude Code assistants.
  • Document that the root README.md duplicates server/README.md rather than serving as a project overview.
  • Note that .github/workflows contains mostly stock, non-project-specific workflows, with CodeQL as the only meaningful PR check.
  • Expand CLAUDE.md with commands for running all tests, single test files, and tests by name, as well as new build, start, and QR generation scripts.

- Add build:web, server build/start, and qr commands to the workflow list
- Document how to run a single test file or test by name with Vitest
- Note that root README.md duplicates server/README.md
- Note that .github/workflows are stock GitHub samples, not project CI

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WE4dzSSfapDKjt5xACz9pd
@sourcery-ai

sourcery-ai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Documentation-only PR updating CLAUDE.md with clarified project guidance, additional build/test commands, and notes about repo structure and CI workflows to better support AI/code-assistant usage and human readers.

Flow diagram for updated development workflow commands in CLAUDE.md

flowchart TD
    A[Start development] --> B[pnpm dev]
    A --> C[pnpm check]
    A --> D[pnpm lint]
    A --> E[pnpm format]

    A --> F[pnpm test]
    F --> G[pnpm test tests/analytics.test.ts]
    F --> H[pnpm vitest run -t calculateNPS]

    A --> I[pnpm build:web]
    A --> J[pnpm build && pnpm start]

    A --> K[pnpm qr exps_url]
Loading

File-Level Changes

Change Details Files
Clarified CLAUDE.md introductory description and repo/file map so readers understand the purpose of key top-level docs and CI workflows.
  • Reworded the header line to explicitly describe CLAUDE.md as guidance for Claude Code when working with this repository.
  • Annotated README.md in the directory map as a duplicate of server/README.md rather than a project overview.
  • Documented that .github/workflows/ contains stock, largely untailored GitHub sample workflows and that only CodeQL meaningfully runs on PRs to main.
CLAUDE.md
Expanded CLAUDE.md development workflow section with more detailed test, build, and utility commands used in this repo.
  • Clarified pnpm test as running the full Vitest suite and added examples for running a single test file and tests filtered by name.
  • Documented pnpm build:web as the static web export used by the Vercel deployment, referencing DEPLOY.md.
  • Added pnpm build && pnpm start as the production server bundle and run flow for the Express/tRPC server.
  • Added pnpm qr as a helper to generate an Expo QR code image for a given URL, pointing to scripts/generate_qr.mjs.
CLAUDE.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@gemini-code-assist gemini-code-assist Bot left a comment

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.

Code Review

This pull request updates CLAUDE.md to clarify guidance for Claude Code, document additional files in the directory structure, and add CLI command examples for testing, building, and running the application. The review feedback suggests improving consistency in the test commands by leveraging the existing pnpm test script instead of calling vitest directly.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread CLAUDE.md
pnpm test # vitest run
pnpm test # vitest run (all tests)
pnpm test tests/analytics.test.ts # run a single test file
pnpm vitest run -t "calculateNPS" # run tests matching a name

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.

medium

Instead of invoking vitest run directly via pnpm vitest run, you can use the existing pnpm test script which is mapped to vitest run. This keeps the commands consistent and leverages the defined package scripts.

Suggested change
pnpm vitest run -t "calculateNPS" # run tests matching a name
pnpm test -t "calculateNPS" # run tests matching a name

@thetigerone888 thetigerone888 linked an issue Jul 28, 2026 that may be closed by this pull request
@thetigerone888 thetigerone888 self-assigned this Aug 4, 2026
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.

APPSTOCK

2 participants