Skip to content

Contributor onboarding + fix dev/e2e port mismatch - #1

Open
unforced wants to merge 1 commit into
mainfrom
docs/contributing-onboarding
Open

Contributor onboarding + fix dev/e2e port mismatch#1
unforced wants to merge 1 commit into
mainfrom
docs/contributing-onboarding

Conversation

@unforced

Copy link
Copy Markdown
Contributor

Sets up the repo for onboarding a new collaborator (frontend-first) and fixes a papercut that would bite them on day one.

What's here

  • CONTRIBUTING.md (new) — prerequisites (Node 20+, Chrome for e2e), clone→install→dev, the feature-branch + PR workflow, the npm test + npm run e2e gate, and a clear table of what needs Cloudflare vs. what doesn't (frontend = nothing). Includes the scoped-API-token path (Edit Cloudflare Workers template **+ D1: Edit`) for when a contributor needs to deploy the Worker.
  • README / CLAUDE.md — pointer to CONTRIBUTING, dev port noted, natalengine version refreshed ^1.3.0 → ^1.6.0.
  • vite.config.js — pin dev server to 5174 (strictPort). The e2e default and the worker's allowed auth origins already assume 5174, but Vite was silently running on 5173, so the documented npm run dev + npm run e2e flow would have failed for a new contributor. Now it works with zero env vars.

Verification

  • npm run build clean
  • npm run dev (now on 5174) + npm run e2e → all checks pass with no E2E_URL override

First PR through the new branch + PR workflow we're adopting. 🌱

🤖 Generated with Claude Code

- CONTRIBUTING.md: prerequisites, the branch+PR workflow, the test gate,
  and a clear "front-end needs no Cloudflare / here's the scoped-token
  path when you do" guide for new collaborators
- README + CLAUDE.md: point to CONTRIBUTING, note the dev port, refresh
  the natalengine version (^1.3.0 → ^1.6.0)
- vite.config: pin the dev server to 5174 (strictPort). The e2e default
  and the worker's allowed auth origins already assume 5174, but Vite was
  silently running on 5173 — so `npm run dev` + `npm run e2e` now work
  together out of the box.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

1 participant