Skip to content

【内容纠错】修改/补充API文档中的注释/功能实现/描述错误等,提升文档阅读性 #1

@OriginQuantumCloud

Description

@OriginQuantumCloud

pyqpanda-algorithm 算法软件包开源了13种不同类型的算法。为提升算法的可维护性与可读性,官方现启动开源共建活动,面向社区征集高质量的算法文档。所有通过的内容将被纳入开源仓库,成为开发者学习与调用的重要参考。
原文档链接:https://qcloud.originqc.com.cn/document/pyqpanda-algorithm/

一、问题方向

  • 补充缺失注释:针对现有模块中未添加文档注释的函数/类,完善基础说明。
  • 修正错误:修正与API实际功能不符、参数/返回值描述错误的现有内容。
  • 优化冗余:简化冗余表述,统一注释风格,提升文档可读性。

二、核心流程
1、认领Issue

  • 在Issue下留言【算法名称,如(Grover算法)】,仓库管理者将在留言后12小时内进行回复;
  • 每位开发者需要从13种算法中选择一个具体的文档完善;Issue支持多名开发者同时认领;
  • 注意:每个算法文档计划接受2-3个S类高质量作品进行PR合并。

2、编写规范

  • 文档风格:需遵循【量子云】官方文档风格,并采用Markdown格式编写。
  • 内容应包含:
    函数/类的功能介绍;
    参数说明(名称、类型、含义、默认值);
    返回值说明(类型、意义);
    可能抛出的异常说明。

3、提交并创建PR

  • 在 PR 描述中填写
    本次文档完善覆盖的算法模块及具体的函数/类;
    关联本Issue(如“关联Issue 【内容纠错】修改/补充API文档中的注释/功能实现/描述错误等,提升文档阅读性 #1”);
    修改内容的简要总结(如“补充了Grover.Module Contents的参数说明与示例代码”)。

  • 分支规范
    必须基于官方 develop 分支创建,避免版本冲突。
    请在develop分支的 docs 目录下提交,命名为【用户名+算法名_doc.md】

  • 提交截止时间
    2026年2月28日

  • 等待代码审查与合入
    完成 CI/CD检查 & code review 修改;
    仓库管理者将集中在 3–5 个工作日内合并 PR。

三、奖励机制
成功合并的PR将清晰标注贡献者信息,并在本源量子云平台进行公示;
成功合并PR的贡献者将获得价值100-150元不等的周边产品(水杯、支架、书籍等)。

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueBeginner-Friendly Algorithm Documentation Contributions. 这里集合了新手友好的算法文档贡献。开源发布Open Source Co-construction Campaign for Algorithms. 开源共建活动

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions