贡献指南

贡献新功能

• 使用补丁打开一个新的 GitHub 拉取请求。
• 确保 PR 描述清楚地描述了问题和解决方案。如果适用，请包含相关的问题编号。

开发工具

为了简化开发周期，提供了一些工具。这些工具可以通过 make 命令从根目录调用。

支持以下命令：

make lint
make install
make examples
make docs
make test
make clean

贡献质量标准

为了保证贡献代码的高质量，项目工作流程会验证添加的修改以及引入的提交消息。相同的机制在本地用于在提交拉取请求之前查找和解决现有问题。

要激活本地机制（使用预提交钩子创建），请运行以下命令：

pip install -r requirements-dev.txt
pre-commit install --hook-type commit-msg --hook-type pre-commit

Git 工作流程

本项目中使用的 Git 工作流程基于这篇博客文章。使用此工作流程可以更好地促进贡献者之间的协作并自动化重复任务。

除了博客文章中描述的工作流程外，Github Actions 会在发布分支上自动检查代码，并从每次推送到主分支时构建文档。目前，我们不使用热修复分支。

分支命名：

• develop: 开发分支
• master: 主分支
• feat/[功能名称]: 功能分支
• docs/[分支名称]: 文档和示例

贡献者许可协议 (CLA)

此包没有贡献者许可协议 (CLA)，因为 GitHub 服务条款提供了一个合理的明确默认：

每当你对包含许可证通知的仓库进行贡献时，你将在相同条款下许可你的贡献，并且你同意你有权在那些条款下许可你的贡献。

阅读 Github 的开源法律指南以获取更多详细信息。

以数据为中心的社区

社区是一个低门槛的地方，可以询问有关开发和贡献的问题。加入 Discord 社区。

更多信息

了解更多关于参与的信息，请阅读 GitHub 上的贡献指南。