Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (48 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 1.8 KB
Raw

Contributing

感谢你愿意参与 AI PR Helper。项目现在由浏览器扩展和 Java 后端两部分组成，欢迎功能开发、Bug 修复、文档完善、测试和安全改进。

本地开发

环境

  • Node.js 18+ 和 npm
  • Java 21 和 Maven 3.6.3+，或 Docker
  • Chromium 浏览器
  • 用于手动端到端测试的 AI API Key

Java 后端

cd backend
export AI_API_KEY=your_api_key_here
mvn spring-boot:run

也可以在仓库根目录复制 backend/.env.example 为 backend/.env，然后运行：

docker compose up --build

不要提交真实的 .env、AI API Key、GitHub Token 或后端访问令牌。

浏览器扩展

npm install
npm run dev

将 build/chrome-mv3-dev 作为未打包扩展加载，并在设置页填写 Java 后端地址。

架构边界

  • backend/ 负责 GitHub Diff 抓取、Prompt、模型请求、重试、安全和 API 错误响应。
  • lib/backend.ts 负责扩展与 Java API 的通信。
  • popup.tsx 负责浏览器交互、预览和 GitHub 页面回填。
  • AI API Key 不应重新放回浏览器端。

提交前检查

npm run backend:test
npm run build

涉及真实模型调用时，还应手动验证：

  1. /api/health 能正确反映 AI 是否已配置
  2. /api/ai/test 能完成模型连接测试
  3. PR 页面和 Compare 页面都能生成描述
  4. GitHub 描述输入框可以正常回填
  5. 错误 Token、无效 URL、GitHub 失败和模型失败都有可理解的提示

Pull Request 建议

PR 请说明：

  • 改了什么以及为什么
  • 对扩展、Java API、配置或部署有何影响
  • 验证命令与手动测试结果
  • 兼容性、安全性或回滚注意事项

如果改动 GitHub DOM 选择器，请写明测试过的页面类型；如果改动 Prompt，请提供前后输出示例。