Repository navigation
docs: add contributor quickstart guide - #119
Merged
ashishsinghbora merged 1 commit intoSep 17, 2026
Merged
ashishsinghbora merged 1 commit into
ashishsinghbora merged 1 commit into
Conversation
Co-authored-by: Ashish Singh Bora <mr.ashishsinghbora@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdguide covering prerequisites, repository configuration, CLI/daemon build instructions, test commands, contribution workflow, troubleshooting, and defensive-use reminders.Changes
docs/CONTRIBUTOR_QUICKSTART.mdwith step-by-step developer setup and validation guidance.Testing
test -z "$(gofmt -l .)"andgit diff --checkgo vet ./...)go test -v -race ./...)Collaboration
This contribution was prepared collaboratively by @AryanXCode646 and @ashishsinghbora.