贡献指南

⚠️ 重要提示：在开始任何新功能或重大更改之前，请先创建一个 issue 来讨论您的提案并获得批准。我们不希望您浪费时间在可能不符合项目方向或无法合并的工作上。

概述

本项目是一个包含两个主要应用的 monorepo：

• CLI：apps/cli
• 文档站点：apps/web

环境设置

前置要求

• Node.js (lts)
• Bun (推荐)
• Git

安装

git clone https://github.com/AmanVarshney01/create-better-t-stack.git
cd create-better-t-stack
bun install

开发 CLI

cd apps/cli
# 可选的全局链接，用于在任何地方测试
bun link
# 以监听模式运行（在监听模式下运行 tsdown build）
bun dev

现在转到您系统中的任何其他位置（可能是测试文件夹）并运行：

create-better-t-stack

这将运行本地安装的 CLI。

开发文档

# 从仓库根目录
bun i
cd packages/backend
bun dev:setup  # 在提示中也可以选择本地开发

将 Convex URL 从 packages/backend/.env.local 复制到 apps/web/.env：

NEXT_PUBLIC_CONVEX_URL=http://127.0.0.1:3210/

现在在根目录运行 bun dev。它会提示缺少 GitHub token，因此在 packages/backend 中运行：

npx convex env set GITHUB_ACCESS_TOKEN=xxxxx
npx convex env set GITHUB_WEBHOOK_SECRET=xxxxx

贡献流程

1. 开始重大工作前先创建 issue/讨论
2. Fork 仓库
3. 创建功能分支
4. 遵循现有代码风格进行更改
5. 根据需要更新文档
6. 测试和格式化

# CLI
cd apps/cli && bun dev
cd apps/cli && bun run test

# Web
bun dev

# 格式化
bun run format

# 类型检查
bun check

7. 提交和推送

git add .
git commit -m "feat(web): ..." # 或 fix(cli): ...
git push origin <your-branch>

8. 创建 Pull Request 并链接相关 issue

提交规范

使用带有适当作用域的传统提交消息：

• feat(cli): 添加新的 CLI 功能
• fix(cli): 修复 CLI bug
• feat(web): 添加新的 web 功能
• fix(web): 修复 web bug
• chore(web): 更新依赖
• docs: 更新文档

帮助

• GitHub 上的 Issues 和 Discussions
• Discord：https://discord.gg/ZYsbjpDaM5

查看仓库中的完整贡献者指南：.github/CONTRIBUTING.md。