贡献 BetterAuth

感谢您对贡献 BetterAuth 的兴趣！本指南是贡献 BetterAuth 的简洁指南。

开始使用

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

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

开发设置

开始开发：

# Replace YOUR-USERNAME with your GitHub username
git clone https://github.com/YOUR-USERNAME/better-auth.git
cd better-auth

pnpm install

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

进行更改

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

# Make sure you're on main
git checkout main

# Pull latest changes
git pull upstream main

# Create and switch to a new branch
git checkout -b feature/your-feature-name

pnpm dev

pnpm -F docs dev

问题和错误修复

• 检查我们的 GitHub 问题 中标记为 good first 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();
        // Test code here
        expect(result).toBeDefined();
    });
});

测试最佳实践

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

需要帮助？

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

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

感谢您贡献 BetterAuth！