为 BetterAuth 贡献代码

感谢您对 Better Auth 的贡献感兴趣！本指南是参与 Better Auth 贡献的简明指南。

开始之前

在深入之前，这里有一些重要资源：

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

开发环境设置

开始开发的步骤：

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

pnpm install

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

进行更改

一旦您明确了想要贡献的内容，就可以开始进行更改。以下是一些入门步骤：

# 确保当前在 main 分支
git checkout main

# 拉取最新更改
git pull upstream main

# 创建并切换到新分支
git checkout -b feature/your-feature-name

pnpm dev

pnpm -F docs dev

问题和错误修复

• 查看我们的 GitHub issues 中标记为 good first issue 的任务
• 报告错误时，请包含重现步骤和预期行为
• 在您想要处理的问题上留言，以避免重复工作

框架集成

我们欢迎为支持更多框架做出贡献：

• 尽可能专注于框架无关的解决方案
• 保持集成的最小化和可维护性
• 所有集成目前都位于主包中

插件开发

• 对于核心插件：请先创建一个 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();
    });
});

测试最佳实践

• 编写清晰的提交信息
• 更新文档以反映您的更改
• 为新功能添加测试
• 遵循我们的编码标准
• 保持拉取请求专注于单一更改

需要帮助？

不要犹豫，随时寻求帮助！您可以：

• 打开一个问题来提问
• 加入我们的社区讨论
• 联系项目维护者

感谢您为 Better Auth 做出贡献！