docs: add contributor onboarding guide#164
Open
YimingIsCOLD wants to merge 7 commits into
Open
Conversation
kellylimmm
approved these changes
May 12, 2026
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
2 participants
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 contributor onboarding documentation. Establishes
CONTRIBUTING.mdas the canonical home for human-facing conventions (style, tests, commits, PRs) and slimsCLAUDE.mdto a@CONTRIBUTING.mdimport so Claude Code's context stays complete without duplication. Adds supporting tooling: aMakefilefor pinnedgolangci-lintinstallation and prerequisite documentation for Go, Node, and pnpm versions.✏️ Changes
README.mdwith project overview, quick start, and contributing pointer.CONTRIBUTING.mdcovering development setup, project structure, branching workflow, code style, test conventions, commit conventions, and PR process.CLAUDE.mdto a@CONTRIBUTING.mdimport.Makefilewith pinnedgolangci-lint(v2.11.4) installed into./bin/.bin/to.gitignore.mise use --globalas the recommended install path.golintscript frompackage.jsonin favor ofmake lint(which uses the pinnedgolangci-lint).🧪 Test Plan
make toolsinstallsgolangci-lint v2.11.4into./bin/golangci-lint-v2.11.4.make lintruns the linter without errors.README.mdandCONTRIBUTING.mdresolve correctly on GitHub.pnpm dev:allstill starts the stack.