CONTRIBUTING_zh_CN.md

为 Rin 做贡献

English | 简体中文

我们很乐意接受您对这个项目的补丁和贡献。您只需遵循一些小指南即可。

Commit-msg 钩子

我们在 scripts/git-commit-msg.sh 中有一个示例 commit-msg hook。请运行以下命令设置：

ln -s ../../scripts/git-commit-msg.sh ./.git/hooks/commit-msg

Windows 下请直接将 git-commit-msg.sh 文件复制到 .git/hooks/commit-msg。

cp .\scripts\git-commit-msg.sh .\.git\hooks\commit-msg

这将在每次提交之前运行以下检查：

1. tsc 检查代码是否存在语法错误与未使用变量与引用
2. 检查提交消息是否以以下之一开头：feat|chore|fix|docs|ci|style|test|pref

如果您想跳过钩子，请使用 --no-verify 选项运行 git commit。

设置开发环境

1. Fork & Clone 仓库

2. 安装 Node & Bun

3. 安装依赖项

   bun i

4. 将 wrangler.example.toml 文件复制到 wrangler.toml 并填写必要信息

   [!TIP]
   通常情况下，您只需要填写 database_name 和 database_id 两项
   S3 相关配置非必须，但是如果您想要使用图片上传功能，您需要填写 S3 配置

5. 将 client/.env.example 文件复制到 client/.env 并修改必要配置

   [!TIP]
   通常情况下，您只需要填写 AVATAR、NAME 和 DESCRIPTION 三项

6. 执行数据库迁移

   [!TIP]
   如果您的数据库名称(wrangler.toml中database_name)不为 rin
   请在执行迁移之前修改 scripts/db-migrate-local.ts 中的 DB_NAME 字段

   bun run db:migrate

7. 配置 .dev.vars 文件 将 .dev.example.vars 复制到 .dev.vars 并填写必要信息

   [!TIP]
   通常情况下，您需要填写 RIN_GITHUB_CLIENT_ID 和 RIN_GITHUB_CLIENT_SECRET 以及 JWT_SECRET 三项
   开发环境下需要单独创建一个 Github OAuth 服务，回调地址为 http://localhost:11498/user/github/callback
   如果手动修改过 server 的监听端口，请同时修改回调地址中的端口号

8. 启动开发服务器

   bun dev

9. 为了更好地控制开发服务器，您可以分别在两个终端中分别运行客户端与服务端的 dev 命令：

   # tty1
   bun dev:client
   
   # tty2
   bun dev:server

提交更改

1. 对于简单的补丁，在 UTC+8 时区的日间通常 10 分钟内即可对其进行审核。

2. 在 PR 准备好进行审核后，不要强制推送小的更改。这样做会迫使维护者重新阅读您的整个 PR，从而延迟审核过程。

3. 始终保持 CI 为绿色。

4. 如果 CI 在您的 PR 上失败，请不要推送。即使您认为这不是补丁的错误。如果其他原因破坏了 CI，请在推送之前帮助修复根本原因。

开始愉快地写代码吧！

代码审核

所有提交，包括项目成员的提交，都需要审核。我们使用 GitHub 拉取请求来实现此目的。有关使用拉取请求的更多信息，请参阅 GitHub 帮助。