Skip to main content
Contributors Guide
- Use Node.js 20 LTS (
nvm use) and runpnpm installat the repo root. - Install Playwright browsers with
npx playwright install chromiumif you plan to run end-to-end tests locally. - Enable the recommended VS Code extensions for linting, formatting, and Svelte language support.
- Create a feature branch from
main(for example,git checkout -b feature/my-change). - Keep pull requests focused on a single concern and include tests plus docs.
- Run
git diff --cached | ./scripts/scan-secrets.pybefore every commit to avoid leaking credentials. - Follow the pull request guide for message structure and review tips.
npm run lintnpm run type-checknpm run buildnpm run test:cinpm run audit:ci- Gameplay or quest changes belong in
/frontend/src/pages/docs/md. - Developer tooling, architecture, or ops updates live under
/docs. - Refresh screenshots when UI changes are visible and add them to
frontend/assetsor quest-specific folders. - Join the Discord
#contributorschannel for pairing and review requests. - Tag issues with
good first issuewhen you notice approachable tasks. - Share lessons learned in the
docs/opsnotebooks so future contributors benefit from your experience.
DSPACE Contributors Guide
Welcome! This guide walks you through the essentials for shipping high-quality
changes to DSPACE. Pair it with the Developer Guide
and the CONTRIBUTING.md
checklist for full coverage.
1. Environment setup
2. Branching & workflow
3. Testing checklist
Before pushing, run the scripts that CI enforces:
Use SKIP_E2E=1 only when browsers are unavailable and call it out in your PR.
Refer to the Testing Guide for component,
integration, and
Playwright best practices.
4. Documentation updates
Every feature or fix should update the relevant docs:
5. Support & community
Thanks for helping us democratize space exploration!
