docs: add local dev setup and contributor onboarding guide - #22
Merged
TomHAnderson merged 2 commits intoMar 5, 2026
Merged
Conversation
- Add docker-compose.yml for a containerised Next.js dev environment (node:18-alpine, hot-reload via volume mount, isolated node_modules) - Document first-time setup, day-to-day workflow, and env configuration - Note that the production GraphQL API is publicly readable — no local backend or database setup required for frontend-only contributions - Add backend complexity warnings (Doctrine ORM, PHP 8.3, XML metadata, empty database, mandatory composer test suite) - Stub Good First Issues section with interim guidance for students - Stub Community Guidelines section with options (Contributor Covenant, CNCF CoC, bespoke CODE_OF_CONDUCT.md) Assisted-by: Claude Sonnet 4.6 via Claude Code Signed-off-by: Cristóbal Palmer <cmp@cmpalmer.org>
Students and other contributors without direct push access need to know how to submit changes via a personal fork. Adds a "Submitting a Pull Request" section with the full gh + git workflow. Assisted-by: Claude Sonnet 4.6 via Claude Code Signed-off-by: Cristóbal Palmer <cmp@cmpalmer.org>
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
2 participants
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
Adds
CONTRIBUTING.mdanddocker-compose.ymlto give student contributors a documented path from zero to a working local environment.docker-compose.yml) —docker compose upstarts the Next.js dev server with hot-reload; no global Node or yarn install requiredNEXT_PUBLIC_GRAPHQL_SERVERoptions; notes explicitly that the production GraphQL API is publicly readable so frontend contributors can see real data immediately without any backend setupgh-based fork workflow for external contributors who don't have direct push accessCODE_OF_CONDUCT.md)The stub sections are intentionally incomplete. Maintainer edits or discussion leading to a revised PR are expected and welcome before this lands.
Test plan
cp .env.local.dist .env.localand setNEXT_PUBLIC_GRAPHQL_SERVER=https://graphql.lcdb.org/docker compose upstarts the dev server at http://localhost:3000docker compose downcleans up without errors