docs: add CLAUDE.md for Claude Code onboarding#307
Open
adminiummomentum wants to merge 1 commit intoabhi1693:masterfrom
Open
docs: add CLAUDE.md for Claude Code onboarding#307adminiummomentum wants to merge 1 commit intoabhi1693:masterfrom
adminiummomentum wants to merge 1 commit intoabhi1693:masterfrom
Conversation
Provides architecture overview, common commands, coding conventions, coverage policy, and CI details so future Claude Code sessions can be productive immediately. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a repository-level CLAUDE.md onboarding document intended to help Claude Code quickly understand the repo’s architecture, workflows, and conventions without additional exploration.
Changes:
- Introduces
CLAUDE.mdwith architecture overview (backend/frontend/services/auth), key repo commands, and CI details - Documents migration/coverage policies and coding conventions (Python/TS, Conventional Commits, etc.)
|
|
||
| ## Environment | ||
|
|
||
| - Copy `.env.example` → `.env` at repo root (and optionally `backend/.env.example` → `backend/.env`, `frontend/.env.example` → `frontend/.env.local`) |
There was a problem hiding this comment.
The frontend env-file guidance is likely to mislead in Docker/installer workflows: docker compose and install.sh both use frontend/.env (not frontend/.env.local). Consider updating this bullet to reference frontend/.env (and optionally mention that Next.js also supports .env.local for non-Docker local dev).
Suggested change
| - Copy `.env.example` → `.env` at repo root (and optionally `backend/.env.example` → `backend/.env`, `frontend/.env.example` → `frontend/.env.local`) | |
| - Copy `.env.example` → `.env` at repo root (and optionally `backend/.env.example` → `backend/.env`, `frontend/.env.example` → `frontend/.env` — Next.js also supports `frontend/.env.local` for non-Docker local dev) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CLAUDE.mdfile with architecture overview, common commands, coding conventions, coverage policy, migration policy, and CI detailsTest plan
🤖 Generated with Claude Code