Skip to content

docs: add contributor quickstart guide - #119

Merged
ashishsinghbora merged 1 commit into
StellarResearch:mainfrom
AryanXCode646:docs/contributor-quickstart
Sep 17, 2026
Merged

ashishsinghbora merged 1 commit into
StellarResearch:mainfrom
AryanXCode646:docs/contributor-quickstart

Conversation

@AryanXCode646

Copy link
Copy Markdown
Contributor

Summary

Adds a concise contributor quickstart guide (docs/CONTRIBUTOR_QUICKSTART.md) to make it easier for new contributors to set up OnionScan and validate changes locally.

Problem

New contributors previously had to piece together local development prerequisites, SQLite/CGO setup, build commands, and testing workflows across multiple architectural and governance documents.

Solution

Created a dedicated, practical docs/CONTRIBUTOR_QUICKSTART.md guide covering prerequisites, repository configuration, CLI/daemon build instructions, test commands, contribution workflow, troubleshooting, and defensive-use reminders.

Changes

  • Added docs/CONTRIBUTOR_QUICKSTART.md with step-by-step developer setup and validation guidance.

Testing

  • Formatting validated with test -z "$(gofmt -l .)" and git diff --check
  • Go static analysis executed (go vet ./...)
  • Local build and test suite executed (go test -v -race ./...)
  • Confirmed no unrelated source files were modified

Collaboration

This contribution was prepared collaboratively by @AryanXCode646 and @ashishsinghbora.

Co-authored-by: Ashish Singh Bora <mr.ashishsinghbora@gmail.com>
@ashishsinghbora ashishsinghbora self-assigned this Sep 17, 2026
@ashishsinghbora
ashishsinghbora requested a review from a team September 17, 2026 15:53
@ashishsinghbora
ashishsinghbora merged commit 933b0a7 into StellarResearch:main Sep 17, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants