Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (43 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 1.21 KB

贡献指南

感谢你考虑为 Cloudflare RAG 做出贡献！

如何贡献

报告 Bug

如果你发现了 bug，请创建一个 Issue 并包含：

  • 详细的问题描述
  • 复现步骤
  • 预期行为
  • 实际行为
  • 环境信息（浏览器、Cloudflare 配置等）

提出新功能

如果你有新功能的想法：

  1. 先创建一个 Issue 讨论
  2. 说明功能的用途和价值
  3. 等待维护者反馈

提交代码

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

代码规范

  • 使用清晰的变量和函数名
  • 添加必要的注释
  • 保持代码简洁
  • 测试你的更改

提交信息规范

  • 使用清晰的提交信息
  • 一个提交只做一件事
  • 中英文均可

开发环境设置

git clone https://github.com/your-username/cloudflare-rag.git
cd cloudflare-rag
npm install

测试

在提交 PR 前，请确保：

  • 代码可以正常部署
  • 所有功能正常工作
  • 没有引入新的 bug

问题？

如果有任何问题，欢迎在 Issue 中提问！