Description
docs/local-development.md exists but is incomplete. New contributors following it often hit errors because steps are missing or out of date. A verified, step-by-step guide is essential for contributor onboarding.
Requirements and context
- Prerequisites: Node.js version, pnpm, Docker, Stellar CLI, Rust (for smart contract development)
- Clone with submodules
- Environment variable setup with every variable explained
- Docker Compose startup sequence and how to verify each service is healthy
- How to run each service individually (SDK, CLI, indexer, notifications)
- How to run tests for each service
- Common errors and their fixes (tested on macOS, Ubuntu, Windows WSL)
Suggested execution
git checkout -b docs/local-dev-complete
- Rewrite
docs/local-development.md
- Test the entire guide on a fresh machine (at least two OS environments)
- Add a troubleshooting section from real contributor issues
Example commit message
docs: rewrite local development guide with verified step-by-step instructions
Description
docs/local-development.mdexists but is incomplete. New contributors following it often hit errors because steps are missing or out of date. A verified, step-by-step guide is essential for contributor onboarding.Requirements and context
Suggested execution
docs/local-development.mdExample commit message
docs: rewrite local development guide with verified step-by-step instructions