-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
good first issueBeginner-Friendly Algorithm Documentation Contributions. 这里集合了新手友好的算法文档贡献。Beginner-Friendly Algorithm Documentation Contributions. 这里集合了新手友好的算法文档贡献。开源发布Open Source Co-construction Campaign for Algorithms. 开源共建活动Open Source Co-construction Campaign for Algorithms. 开源共建活动
Description
pyqpanda-algorithm 算法软件包开源了13种不同类型的算法。为提升算法的可维护性与可读性,官方现启动开源共建活动,面向社区征集高质量的算法原理推导内容。所有通过的内容将被纳入开源仓库,成为开发者学习与调用的重要参考。
一、内容要求
开发者需要选择一个具体的算法进行拆解,包含以下内容:
- 引言 :算法的背景、目的(包含背景、研究意义、现有研究现状);
- 描述 :基础构造过程(描述算法的设计思路、原理、步骤和流程);
- 实验结果与分析 :用具体的数学案例,展示算法的实验结果,并进行详细分析;
- 结论 :总结算法的性能、优缺点和应用前景;
- 参考文献 :列出算法说明中引用的文献。
二、核心流程
1、认领Issue
- 在Issue下留言【算法名称,如(
QAOA算法推导)】,官方将在留言后12小时内进行回复; - Issue支持多名开发者同时认领;
- 注意:每个算法计划接受2-3个S类高质量文档进行PR合并,鼓励深化个人理解,呈现对具体算法的推导。
2、编写规范
- 文档格式:请使用
Markdown格式编写,并确保排版清晰、公式正确。
3、提交并创建PR
-
在 PR 描述中填写
本次覆盖的算法模块。
需关联本Issue(如“关联Issue 【算法拆解】补充关键算法的原理与推导过程,共建高质量算法文档 #2”)。
简要说明算法理解与推导的思路。 -
分支规范
必须基于官方develop分支创建,避免版本冲突。
请在develop分支对应docs目录下提交,命名为【用户名+算法名_deduce.md】 -
提交截止时间
2026年2月28日 -
等待代码审查与合入
完成 CI/CD检查 & code review 修改;
maintainer 将集中在 3–5 个工作日内合并 PR。
三、奖励机制
成功合并的PR将清晰标注贡献者信息,并在本源量子云平台进行公示;
成功合并PR的贡献者将获得价值100-150元不等的周边产品(水杯、支架、书籍等)。
Metadata
Metadata
Assignees
Labels
good first issueBeginner-Friendly Algorithm Documentation Contributions. 这里集合了新手友好的算法文档贡献。Beginner-Friendly Algorithm Documentation Contributions. 这里集合了新手友好的算法文档贡献。开源发布Open Source Co-construction Campaign for Algorithms. 开源共建活动Open Source Co-construction Campaign for Algorithms. 开源共建活动