Description
Write a step-by-step local development setup guide so new contributors can get from clone to a passing test suite without needing to ask a maintainer for basic setup help.
Requirements and Context
- Setup knowledge (Rust/Cargo versions, SDK pin, wasm target, Windows build quirks) currently only exists in maintainer context and is not documented anywhere in the repo
- Must explain the soroban-sdk = 27.0.3 pin specifically (27.0.5 is missing soroban-ledger-snapshot on crates.io, so it cannot be used)
- Must explain the wasm32v1-none build target requirement
- Must explain the crate-type distinction: ["rlib"] is required for cargo test to pass, ["cdylib", "rlib"] is required for stellar contract build to succeed - this is a Windows/MinGW constraint contributors will hit if not documented
Suggested Execution
Branch name: docs/dev-setup-guide
Files to touch:
- docs/DEVELOPMENT.md (new)
- README.md (add link to new doc)
- CONTRIBUTING.md (add link to new doc)
Example commit message: docs(dev): add local development setup guide
Test and Commit
Guidelines
Complexity
Trivial - 100 points
Description
Write a step-by-step local development setup guide so new contributors can get from clone to a passing test suite without needing to ask a maintainer for basic setup help.
Requirements and Context
Suggested Execution
Branch name: docs/dev-setup-guide
Files to touch:
Example commit message: docs(dev): add local development setup guide
Test and Commit
Guidelines
Complexity
Trivial - 100 points