From c403183211d033fe1228dcd0b6a043d867de0e3c Mon Sep 17 00:00:00 2001 From: Masataka Yakura Date: Tue, 17 Mar 2026 03:31:20 +0900 Subject: [PATCH 1/3] docs: add prerequisites and setup instructions to Contributing section 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 --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index ecd1a85..d490a28 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,28 @@ This is error text. ## Contributing +### Prerequisites + +- [Node.js](https://nodejs.org/) v20.12.0 +- [Bun](https://bun.sh/) v1.0.36 + +### Setup + +```sh +bun install +``` + +### Commands + +```sh +bun test # run tests +bun run build # build the package +bun run tsc # type check +bun run ci # lint and format check +``` + +### Workflow + 1. Fork it! 2. Create your feature branch: `git checkout -b my-new-feature` 3. Commit your changes: `git commit -am 'Add some feature'` From 38fbec763b68e69ca123b5ca1ff7f25c455612ea Mon Sep 17 00:00:00 2001 From: Masataka Yakura Date: Tue, 17 Mar 2026 12:23:54 +0900 Subject: [PATCH 2/3] docs: refer to .tool-versions for exact prerequisite versions Co-Authored-By: Claude Sonnet 4.6 --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d490a28..515f01b 100644 --- a/README.md +++ b/README.md @@ -64,8 +64,10 @@ This is error text. ### Prerequisites -- [Node.js](https://nodejs.org/) v20.12.0 -- [Bun](https://bun.sh/) v1.0.36 +- [Node.js](https://nodejs.org/) +- [Bun](https://bun.sh/) + +See `.tool-versions` for the exact versions required. ### Setup From 8dbc939ec613dac61cd8fb43b707a30a5cf8185e Mon Sep 17 00:00:00 2001 From: Masataka Yakura Date: Tue, 17 Mar 2026 12:55:53 +0900 Subject: [PATCH 3/3] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 515f01b..b05e6f9 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ This is error text. - [Node.js](https://nodejs.org/) - [Bun](https://bun.sh/) -See `.tool-versions` for the exact versions required. +See the Node.js and Bun entries in `.tool-versions` for the exact versions used in this project. ### Setup