Description
New contributors currently face a complex multi-step setup: configuring environment variables, starting Docker services, deploying to Testnet, and understanding how pipeline components interact. The existing CONTRIBUTING.md describes individual steps but does not provide a cohesive zero-to-hero guide that takes a developer from a fresh clone to a running local pipeline with a test wallet being scored.
What needs to be built
- Write
docs/developer_quickstart.md covering: prerequisites, docker compose up step-by-step, running the full pipeline against Testnet with make run-testnet, verifying a test wallet's risk score, running the test suite, and a troubleshooting section for the 5 most common setup errors.
- Add
make run-testnet Makefile target that starts Docker services and runs scripts/stream.py with Testnet defaults.
- Add
make check-env Makefile target that validates all required env vars before pipeline start, producing a clear human-readable error per missing var.
Requirements
Functional
- The quickstart must be validated end-to-end by a person who has never seen the repo before merging.
make check-env must produce a clear per-variable error message, not a Python traceback.
Testing
- CI must verify
make check-env exits 0 with all env vars set.
- CI must verify
make check-env exits non-zero with a specific missing env var and produces the expected error message.
Security
- The quickstart must prominently warn: never use mainnet keypairs for testing; never commit
.env files; testnet and mainnet configs must be kept strictly separate.
Documentation
- This issue is primarily a documentation and tooling task; the quickstart guide and Makefile targets are the deliverables.
Contributor guidance
Area of specialty: Developer experience, documentation, DevOps, Docker, Stellar SDK.
How to contribute:
- Comment describing your experience writing onboarding guides for open-source projects.
- Propose the 5 most common first-time setup errors based on
CONTRIBUTING.md and the existing issue tracker.
- PR must include the quickstart guide, both Makefile targets, and both CI
check-env tests.
Description
New contributors currently face a complex multi-step setup: configuring environment variables, starting Docker services, deploying to Testnet, and understanding how pipeline components interact. The existing
CONTRIBUTING.mddescribes individual steps but does not provide a cohesive zero-to-hero guide that takes a developer from a fresh clone to a running local pipeline with a test wallet being scored.What needs to be built
docs/developer_quickstart.mdcovering: prerequisites,docker compose upstep-by-step, running the full pipeline against Testnet withmake run-testnet, verifying a test wallet's risk score, running the test suite, and a troubleshooting section for the 5 most common setup errors.make run-testnetMakefile target that starts Docker services and runsscripts/stream.pywith Testnet defaults.make check-envMakefile target that validates all required env vars before pipeline start, producing a clear human-readable error per missing var.Requirements
Functional
make check-envmust produce a clear per-variable error message, not a Python traceback.Testing
make check-envexits 0 with all env vars set.make check-envexits non-zero with a specific missing env var and produces the expected error message.Security
.envfiles; testnet and mainnet configs must be kept strictly separate.Documentation
Contributor guidance
Area of specialty: Developer experience, documentation, DevOps, Docker, Stellar SDK.
How to contribute:
CONTRIBUTING.mdand the existing issue tracker.check-envtests.