fix: correct stale .env.example references to the make dev auto-create flow#146
fix: correct stale .env.example references to the make dev auto-create flow#146Jacob-9909 wants to merge 1 commit into
Conversation
The repo referenced a `.env.example` file that does not exist. The README was refactored so `make dev` auto-creates a local `.env` (the validate-dev-env target), but six stale references remained — in CLAUDE.md, backend/CLAUDE.md, backend/README.md, and three Makefile error messages — telling users to copy a nonexistent template. A new contributor following the setup, or running `make convex-push`/`make seed-public-datasets` standalone, hits a misleading instruction. Point all references at the actual auto-create flow instead.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughAll references to the manual 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
What
The repo references a
.env.examplefile that doesn't exist anywhere in the tree (git ls-files/findconfirm it's not tracked or present). The README was refactored somake devauto-creates a local.env(thevalidate-dev-envtarget inmakefiles/Makefile), and the top-level README no longer mentions a template to copy — but six stale references were left behind:CLAUDE.md— Setup step 1: "Copy.env.exampleto.env"backend/CLAUDE.md— "Required env vars (see.env.example)"backend/README.md—cp .env.example .envmakefiles/Makefile— three error messages (convex-env,convex-push,seed-public-datasets):Error: .env not found. Run: cp .env.example .envWhy
A new contributor following the setup instructions, or running
make convex-push/make seed-public-datasetsstandalone beforemake dev, hits an instruction telling them to copy a file that doesn't exist.Change
Point every reference at the actual flow:
make devauto-creates a local.env. Docs-and-strings only — no behavior change.Verification
grep -rn "env.example"over the tree returns no matches after the change.make -nparses the Makefile cleanly.