Add Claude.md #2103
Add Claude.md #2103
Conversation
|
WalkthroughA new entry, 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (16)
CLAUDE.md (16)
1-1: Use a concise document title.
The header# CLAUDE.mdincludes the file extension; consider changing it to something more reader-friendly, e.g.,# Claude Code Guidanceor simply# Claude.
3-3: Clarify the introduction.
Rephrase the opening line and hyperlink the URL for clarity, for example:This document provides guidance for using Claude Code (https://claude.ai/code) with this repository.
10-10: Use full install command.
Replace the shorthandpnpm iwithpnpm installto avoid ambiguity and help new contributors understand the command.
19-21: Split complex build step.
Chaining multiple builds on one line can obscure errors. Split into discrete commands or use Turborepo’spnpm turbo run build, for example:pnpm run build --filter=webapp pnpm run build --filter='@trigger.dev/*' pnpm run typecheck
27-28: Quote all filter arguments.
Wrap every--filtervalue in quotes (e.g.,--filter='trigger.dev') to prevent shell globbing inconsistencies.
34-37: Standardize quoting in test filters.
Some filters (e.g.,"@trigger.dev/*") are quoted while others (webapp,@internal/run-engine) are not. Pick one style for consistency.
44-47: Add directory paths to services.
To improve clarity, list service directories explicitly, for example:- **Apps**: `apps/webapp`, `apps/supervisor`
51-55: Consider ordering key components.
You might alphabetize or prioritize by usage (e.g., SDK first) so that the most important packages are immediately visible.
59-62: Include Node.js version in build system.
Since Node.js 20.11.1 is enforced later, list it here alongside TypeScript, Vitest, and PNPM versions to centralize version requirements.
66-66: Shorten the section heading.
Rename### Making Changes to SDK/CLIto### SDK/CLI Changesfor brevity and consistency with other headings.🧰 Tools
🪛 LanguageTool
[style] ~66-~66: Consider shortening or rephrasing this to strengthen your wording.
Context: ... version ## Development Workflows ### Making Changes to SDK/CLI 1. Make changes in `packages/t...(MAKE_CHANGES)
78-78: Separate migration steps.
Splittingpnpm run db:migrate:deploy && pnpm run generateinto two commands improves error isolation:
pnpm run db:migrate:deploy pnpm run generate
82-84: Use inline code for single commands.
A single command likepnpm run changeset:addreads more concisely as inline code than a full code block.
88-91: Link testing tools.
Consider adding links to Vitest, Testcontainers, and Playwright documentation to help contributors find example configs or further reading.
97-100: Reference config files in prerequisites.
When listing Node.js and Docker prerequisites, point to the.nvmrcand Docker-Compose or.env.examplefiles so users know exactly where to look.
104-104: Consistent punctuation in bullets.
Decide whether environment variable descriptions end with colons or not, and apply the same style throughout (e.g., omit the colon afterENCRYPTION_KEY).🧰 Tools
🪛 LanguageTool
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...nvironment Variables -ENCRYPTION_KEY: Generate withopenssl rand -hex 16- ...(UNLIKELY_OPENING_PUNCTUATION)
110-113: Ensure EOF newline.
Add a trailing newline at the end of the file to comply with POSIX standards and avoid warnings in some tools.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.gitignore(1 hunks)CLAUDE.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CLAUDE.md
[style] ~66-~66: Consider shortening or rephrasing this to strengthen your wording.
Context: ... version ## Development Workflows ### Making Changes to SDK/CLI 1. Make changes in `packages/t...
(MAKE_CHANGES)
[uncategorized] ~104-~104: Loose punctuation mark.
Context: ...nvironment Variables - ENCRYPTION_KEY: Generate with openssl rand -hex 16 - ...
(UNLIKELY_OPENING_PUNCTUATION)
🔇 Additional comments (1)
.gitignore (1)
67-67: Ignore Claude artifacts.
Adding.claudeto.gitignoreensures that any files or folders generated by Claude Code aren’t accidentally committed, keeping the repo clean and in sync with the new documentation.
No description provided.