Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (46 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

70 lines (46 loc) · 1.4 KB

贡献指南

感谢你对 UpdateWhat 感兴趣！欢迎贡献！

开发流程

  1. Fork 这个仓库
  2. 创建你的特性分支 (git checkout -b feature/amazing-feature)
  3. 提交你的修改 (git commit -m 'Add some amazing feature')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 创建一个 Pull Request

开发环境

前置要求

  • Node.js 18+
  • pnpm

本地开发

# 克隆你的 fork
git clone https://github.com/<your-username>/updateWhat-web.git
cd updateWhat-web

# 安装依赖
pnpm install

# 复制环境变量示例
cp .env.example .env

# 编辑环境变量，填入你的配置
# GITHUB_TOKEN 和 OPENAI_API_KEY 是必需的

# 启动开发服务器
pnpm dev

打开浏览器访问 http://localhost:3000

代码规范

  • 使用 TypeScript，确保类型正确
  • 遵循现有的代码风格
  • 使用 ESLint 检查代码：pnpm lint

提交规范

提交信息格式建议：

  • feat: 新功能
  • fix: 修复 bug
  • docs: 文档更新
  • refactor: 代码重构
  • perf: 性能优化
  • style: 代码格式调整
  • test: 添加测试

报告问题

如果你发现了 bug 或者有功能建议，请创建一个 Issue，选择合适的模板填写即可。

提问

如果你有任何问题，可以创建一个 Issue 提问。

代码审核

所有 Pull Request 都需要经过代码审核后才会合并。