为BetterAuth做贡献

感谢您有兴趣为Better Auth做贡献！本指南是为Better Auth做贡献的简明指南。

入门指南

在开始之前，以下是一些重要的资源：

查看我们现有的问题和拉取请求
加入我们在Discord上的社区讨论

开发环境设置

要开始开发：

确保您已安装Node.JS ，最好是LTS版本。

1. Fork仓库

访问 https://github.com/better-auth/better-auth

点击右上角的"Fork"按钮。

2. 克隆您的fork

# 将YOUR-USERNAME替换为您的GitHub用户名
git clone https://github.com/YOUR-USERNAME/better-auth.git
cd better-auth

3. 安装依赖

确保您已安装pnpm！

pnpm install

4. 准备环境变量文件

复制示例环境变量文件以创建新的.env文件。

cp -n ./docs/.env.example ./docs/.env

进行更改

一旦您有了想要贡献的想法，您可以开始进行更改。以下是开始的一些步骤：

1. 创建新分支

# 确保您在main分支上
git checkout main
 
# 拉取最新更改
git pull upstream main
 
# 创建并切换到新分支
git checkout -b feature/your-feature-name

2. 启动开发服务器

启动开发服务器：

pnpm dev

启动文档服务器：

pnpm -F docs dev

3. 进行您的更改

对代码库进行更改。
如有需要，编写测试。（在此处阅读更多关于测试的信息）
更新文档。（在此处阅读更多关于文档的信息）

问题和Bug修复

查看我们的GitHub问题，寻找标记为good first issue的任务
报告bug时，包括重现步骤和预期行为
在您想要处理的问题上发表评论，以避免重复工作

框架集成

我们欢迎对支持更多框架的贡献：

尽可能专注于与框架无关的解决方案
保持集成简单且可维护
所有集成目前都在主包中

插件开发

对于核心插件：首先开一个issue讨论您的想法
对于社区插件：可以独立开发
遵循我们的插件架构指南

文档

修复拼写错误和错误
添加示例并澄清现有内容
确保文档与代码更改保持同步

测试

我们使用Vitest进行测试。将测试文件放在它们测试的源文件旁边：

import { describe, it, expect } from "vitest";
import { getTestInstance } from "./test-utils/test-instance";
 
describe("Feature", () => {
    it("should work as expected", async () => {
        const { client } = getTestInstance();
        // 测试代码
        expect(result).toBeDefined();
    });
});