Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
95 lines (71 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

95 lines (71 loc) · 1.81 KB

贡献指南

感谢您对 Cursor2API 项目的关注！我们欢迎所有形式的贡献。

🚀 如何贡献

报告 Bug

如果您发现了 bug，请通过 GitHub Issues 报告，包含以下信息：

  • Bug 的详细描述
  • 复现步骤
  • 预期行为
  • 实际行为
  • 环境信息（操作系统、Python 版本等）

提出新功能

  1. 先在 Issues 中讨论您的想法
  2. 等待社区反馈
  3. 获得认可后开始实现

提交代码

  1. Fork 仓库

    git clone https://github.com/yourusername/cursor2api.git
cd cursor2api

  2. 创建分支

    git checkout -b feature/your-feature-name

  3. 编写代码

    • 遵循现有的代码风格
    • 添加必要的注释
    • 更新文档

  4. 测试

    python test_all_models.py

  5. 提交更改

    git add .
git commit -m "feat: 添加新功能"

  6. 推送分支

    git push origin feature/your-feature-name

  7. 创建 Pull Request

📝 代码规范

Python 代码风格

  • 遵循 PEP 8
  • 使用有意义的变量名
  • 添加适当的类型提示
  • 编写清晰的文档字符串

提交信息规范

使用语义化提交信息：

  • feat: 新功能
  • fix: Bug 修复
  • docs: 文档更新
  • style: 代码格式调整
  • refactor: 代码重构
  • test: 测试相关
  • chore: 构建过程或辅助工具的变动

🔍 代码审查

所有的 PR 都需要经过代码审查：

  • 确保代码质量
  • 检查是否有潜在问题
  • 验证功能正确性
  • 确认文档完整性

📄 许可证

通过贡献代码，您同意将代码以 MIT 许可证发布。

💬 获取帮助

如有问题，可以通过以下方式获取帮助：

  • 查看项目文档
  • 在 Issues 中提问
  • 参与社区讨论

感谢您的贡献！🎉