Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (63 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

89 lines (63 loc) · 3.87 KB

贡献指南

欢迎社区贡献代码、报告问题或提出改进建议。我们致力于打造一个开放、协作的开发环境。

如何贡献

  1. Fork项目 - 在GitHub上fork项目到您自己的仓库。
  2. 创建分支 - 从 main 分支创建一个新分支来进行您的修改： 
    git checkout -b feature/your-new-feature
  3. 提交代码 - 进行修改并提交您的代码。请遵循下面的 git commit 最佳实践。 
    git commit -m 'feat: 添加了某个很棒的功能'
  4. 推送分支 - 将您的分支推送到您的fork仓库： 
    git push origin feature/your-new-feature
  5. 提交PR - 在SimTradeLab的GitHub仓库页面上创建一个Pull Request，详细描述您的修改内容。

Git Commit 最佳实践

我们遵循 Conventional Commits 规范，这有助于我们自动化生成更新日志和更好地管理项目历史。

Commit 消息格式

每个 commit 消息都由一个 header, 一个 body 和一个 footer 组成。

<type>[optional scope]: <description>

[optional body]

[optional footer]

Commit 类型

请使用以下类型之一作为 commit 的前缀：

类型 用途说明 示例
feat 新功能 feat: 添加策略回测模块
fix Bug 修复 fix: 修复数据源连接失败问题
docs 文档更新 docs: 更新API使用说明
style 代码格式调整（无逻辑变更） style: 格式化回测结果展示代码
refactor 重构（非功能变更） refactor: 重构任务调度逻辑
test 添加或修改测试 test: 增加策略回测单元测试
chore 构建工具或依赖更新 chore: 升级pandas版本

版权和许可证

SimTradeLab 采用双许可证模式（AGPL-3.0 + 商业许可证）。

贡献者许可协议（CLA）

当您向本项目提交代码（通过 Pull Request 或其他方式）时，即表示您：

  1. 版权归属 - 您拥有提交代码的完整版权，或已从版权所有者获得充分授权
  2. 开源许可 - 您同意您的贡献按照 GNU Affero General Public License v3.0 (AGPL-3.0) 许可证发布
  3. 商业许可 - 您同意项目维护者（Kay）有权将您的贡献用于商业许可证授权，用于商业客户的闭源使用场景
  4. 无附加限制 - 您的贡献不包含任何第三方专利、商标或其他知识产权限制
  5. 真实身份 - 您使用真实身份（或经授权的公司身份）提交代码

为什么需要双许可证授权？

SimTradeLab 的双许可证模式旨在：

  • 开源社区：通过 AGPL-3.0 保持项目开源，确保改进回馈社区
  • 商业用户：为需要闭源使用的企业提供商业许可选项
  • 可持续发展：商业授权收入支持项目的长期维护和改进

您的贡献使这种模式成为可能，我们对此深表感谢。

第三方依赖

如果您的贡献引入了新的第三方库，请确保：

  • 该库的许可证与 AGPL-3.0 兼容（MIT、BSD、Apache 2.0 等）
  • 在 pyproject.toml 中明确声明依赖
  • 在 PR 中说明新依赖的用途和许可证

问题反馈

感谢您的贡献！