Read the docs
Start with the Neptune documentation to understand the protocol, wallet, node, transactions, proofs, and core concepts.
Developer starting points
Read the docs, run the software, then pick something small and see it through to a merged pull request.
Run the software
The best way to learn is to run the software. Start from the latest release, create a wallet, start the daemon, and explore the CLI or dashboard.
Explore the code
Browse the repos, read the READMEs (each covers platform setup and build steps), build locally, and look through open issues.
Building a tool or integration?
Start with the RPC interface: neptune-core exposes a tarpc API with JSON transport, the same interface the official CLI and dashboard are built on, and the workspace ships RPC client crates for integrators.
Suggested workflow
- Find an issue: Browse open issues on GitHub and pick something that interests you. Start from the good-first-issue list if you're new to the codebase.
- Share your approach early: Post on Neptune Talk or open a draft PR before you get too deep, so you're not building in the wrong direction.
- Submit and stay engaged: Open your PR, respond to feedback, and see it through to merge.
Before you push: run cargo fmt and cargo clippy --all-targets, use conventional commit messages, and include a regression test if you are fixing a bug. The contributing guide covers the details.