跳到内容

贡献指南

贡献新功能

  • 在 GitHub 上发起一个新的包含补丁的 pull request。
  • 确保 PR 描述清晰地说明问题和解决方案。如果适用，请包含相关的 issue 编号。

开发工具

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

支持以下命令

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

贡献质量标准

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

要激活本地机制（使用 pre-commit 钩子创建），请运行以下命令

pip install ".[dev]"
pre-commit install --hook-type commit-msg --hook-type pre-commit

Git 工作流程

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

除了博文中描述的工作流程外，Github Actions 会在 release 分支上自动 lint 代码，并从每次推送到 master 分支的提交构建文档。目前，我们不使用 hotfix 分支。

分支命名

  • develop: 开发分支
  • master: master 分支
  • feat/[FEATURE NAME]: feature 分支
  • docs/[branch name]: 文档和示例

Git workflow for this project. Based on work by Vincent Driessen, Creative Commons BY-SA.

贡献者许可协议 (CLA)

此软件包不包含贡献者许可协议 (CLA)，因为 GitHub 服务条款提供了一个合理的明确的默认设置

每当你向包含许可声明的仓库贡献代码时，即表示你根据相同条款许可你的贡献，并且同意你有权根据这些条款许可你的贡献。

阅读 Github 的开源法律指南了解更多详情。

Discord 数据中心社区

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

更多信息

阅读GitHub 上的贡献指南，了解如何参与。