豆豆友情提示:这是一个非官方 GitHub 代理镜像,主要用于网络测试或访问加速。请勿在此进行登录、注册或处理任何敏感信息。进行这些操作请务必访问官方网站 github.com。 Raw 内容也通过此代理提供。
Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.91 KB

File metadata and controls

56 lines (39 loc) · 1.91 KB

Contribution Guide

Contributions Welcome! We will be glad for your help. You can contribute in the following ways.

  • Create an Issue - Propose a new feature. Report a bug.
  • Pull Request - Fix a bug or typo. Refactor the code.
  • Create third-party middleware - See instructions below.
  • Share - Share your thoughts on the Blog, X, and others.
  • Make your application - Please try to use Hono.

Note: This project is started by Yusuke Wada (@yusukebe) for the hobby proposal. It was just for fun. For now, this stance has not been changed basically. I want to write the code as I like. So, if you propose great ideas, but I do not appropriate them, the idea may not be accepted.

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 and hot, beautiful, and ultrafast.

Installing dependencies

The honojs/hono project uses Bun as its package manager. Developers should install Bun.

After that, please install the dependency environment.

bun install --frozen-lockfile

PRs

Please ensure your PR passes tests with bun run test.

Third-party middleware

Third-party middleware is not in the core. It is allowed to depend on other libraries or work only in specific environments, such as Cloudflare Workers. For example:

  • GraphQL Server middleware
  • Firebase Auth middleware
  • Sentry middleware

You can make a third-party middleware by yourself. It may be under the "honojs organization" and distributed in the @honojs namespace.

The monorepo "honojs/middleware" manages these middleware. If you want to do it, create an issue about your middleware.

Local Development

git clone git@github.com:honojs/hono.git && cd hono/.devcontainer && bun install --frozen-lockfile
docker compose up -d --build
docker compose exec hono bash