贡献指南（Contributing Guide）

August 7, 2026 · View on GitHub

感谢您对 PyQPanda3 量子编程技能包的兴趣！本仓库以文档为主，任何改进都欢迎。

反馈与建议

  • 发现 API 文档错误、示例运行失败 → 提交 Issue
  • 有新的量子算法模板或最佳实践 → 提交 Pull Request

提交流程

  1. Fork 本仓库并创建功能分支：git checkout -b docs/xxx（或 fix/xxx）
  2. 修改文档，遵循现有格式（表格、代码块、中文为主 + 英文版同步）
  3. 提交信息遵循 Conventional Commits：docs: ... / fix: ...
  4. 推送分支并创建 Pull Request，描述变更内容与验证方式

注意事项

  • 所有代码示例必须使用 pyqpanda3 现代语法（from pyqpanda3.core import *），不使用旧版 pyqpanda
  • API 密钥一律使用 "your_api_key_here" 占位符，禁止硬编码
  • 新增资源文件时更新 resources/api_reference.md 导航表
  • 修改文档后请运行 ./install.sh --help 确认安装脚本不受影响