docs: add prerequisites and setup instructions to Contributing section - #13
Open
myakura wants to merge 4 commits into
Open
docs: add prerequisites and setup instructions to Contributing section#13myakura wants to merge 4 commits into
myakura wants to merge 4 commits into
Conversation
The contributing section only had a generic GitHub workflow with no mention of required tools or how to set up the project. New contributors had to spend time figuring out that Bun (and Node.js for npm publishing) are needed, and which versions to install. Added prerequisites with versions from .tool-versions, setup command, and key development commands. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the README’s Contributing section to better onboard new contributors by documenting required tooling and common development commands.
Changes:
- Added prerequisites (Node.js + Bun) and pointed to
.tool-versionsfor pinned versions. - Added basic setup instructions (
bun install). - Documented key contributor commands (test/build/typecheck/CI).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This was referenced Aug 10, 2026
Contributor
Author
Member
|
I agree that the existing contributing guide is rather sparse. However, the required tools, package manager, and available tasks are already clear from I think contributor documentation is most valuable when it captures project-specific knowledge that cannot be inferred from the codebase itself. |
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
The Contributing section only had a generic GitHub workflow with no mention of required tools. As a new contributor, I spent a few minutes trying to figure out which tools to install and what versions were expected — none of that was documented.
This PR adds:
.tool-versionsbun installto get startedbun test,bun run build,bun run tsc,bun run ci)🤖 Generated with Claude Code