From 5c3a1bf23dcfa3a836488c9174ca11583cb87ace Mon Sep 17 00:00:00 2001 From: Yusuke Wada Date: Mon, 29 Jan 2024 23:38:30 +0900 Subject: [PATCH] docs(contributing): add `Installing dependencies` (#2113) --- docs/CONTRIBUTING.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 126ea9454..5be42d90f 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -18,9 +18,25 @@ So, if you propose great ideas, but I do not appropriate them, the idea may not Although, don't worry! Hono is tested well, polished by the contributors, and used by many developers. And I'll try my best to make Hono cool, beautiful, and ultrafast. +## Installing dependencies + +The `honojs/hono` project uses [Bun](https://bun.sh/) as its package manager. Developers should install Bun. + +After that, please install the dependency environment. + +```txt +bun install +``` + +If you can't do that, there is also a `yarn.lock` file, so you can do the same with the `yarn` command. + +```txt +yarn install --frozen-lockfile +``` + ## PRs -Please ensure your PR passes tests with `yarn test:all`. Also please ensure the Deno code is generated with `yarn denoify`. +Please ensure your PR passes tests with `bun run test` or `yarn test`. Also please ensure the Deno code is generated with `yarn denoify`. ## Third-party middleware