代码贡献指南

如何对Quatm项目贡献您的智慧

Quatm是一个开源项目，我们热爱并欢迎大家提交补丁和贡献，以使Quatm及其文档变得更好。

贡献Quatm

Quatm主要托管在 https://github.com/quatm/quatm，并在项目私有Git服务器进行镜像备份。

贡献者许可协议

在您参与对本项目的贡献时，除非在有书面协议的例外情况下，您（或您的雇主）保留对您的贡献的版权，并自动给予我们使用和重新分发您的贡献作为项目一部分的权限。具体细节请参考本项目的贡献者许可协议。

代码审核

所有提交都需要经过审核。我们使用 GitHub 的Pull Request（Merge Request）进行代码审核。

社区准则

在交流讨论中，请遵循 Quatm社区准则。

创建问题

如果您想在Quatm中看到某些功能（或者发现某些功能没有按预期工作），但您不确定如何自己修复，请创建一个 issue。您也可以通过社交媒体直接与我们联系。

报告 Bug

  • 使用 GitHub Issue 的 Bug 报告模板创建新 Issue
  • 详细描述问题：你期望看到什么？实际看到了什么？
  • 附上截图和 GIF 动画，展示操作步骤和问题现象
  • 提供复现步骤，使维护者能快速定位问题

功能建议

  • 使用 GitHub Issue 的功能建议模板
  • 清晰简洁地描述建议的功能
  • 尽可能包含使用场景和预期效果

Pull Request 流程

  1. Fork 项目仓库
  2. 创建功能分支：git checkout -b feature/my-feature
  3. 编写代码并添加测试
  4. 确保所有状态检查通过
  5. 提交 PR 并填写 PR 模板

代码风格

Python 代码风格

所有 Python 代码必须遵循 PEP 8 规范：

  • 使用 4 空格缩进
  • 类名使用 CamelCase，函数和变量使用 snake_case
  • 导入顺序：标准库 → 第三方库 → 本地模块
  • 为公开 API 编写 docstring

Git 提交信息规范

  • 使用现在时态（“Add feature”，不是 “Added feature”）
  • 使用祈使语气（“Move cursor to…"，不是 “Moves cursor to…"）
  • 第一行限制在 72 字符以内
  • 在第一行之后引用相关 Issue 编号

示例：

Add temperature monitor driver for LFI3751

Implement RS-232 communication and PID auto-tuning
for the Wavelength Electronics LFI3751 controller.

Closes #42

社区联系方式