贡献指南

本项目欢迎广大开发者体验并参与贡献,在参与社区贡献之前。请参见cann-community了解行为准则,进行CLA协议签署,了解源码仓的贡献流程。

开发者准备本地代码与提交PR时需要重点关注如下几点:

  1. 提交PR时,请按照PR模板仔细填写本次PR的业务背景、目的、方案等信息。
  2. 若您的修改不是简单的bug修复,而是涉及到新增特性、新增接口、新增配置参数或者修改代码流程等,请务必先通过Issue进行方案讨论,以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为“简单的bug修复”,亦可通过提交Issue进行方案讨论。

贡献流程

1. 创建Issue需求

新建 Requirement|需求建议 类Issue,并阐明新增算子的设计方案。Issue一般需包含以下内容:

  • 背景信息
  • 价值/作用
  • 设计方案

请在提交的Issue中评论/assign @yourself 认领该任务。

2. 需求评审

Sig组将指派Committer对您提交的Issue进行评审并反馈修改意见。请在完成修改后,于Issue中@对应Committer。

若需求被接纳,sig成员将为您分配合适的贡献目录。

3. PR提交

PR上库要求:

  • 代码合规:
  • 文档合规:文档写作规范参考文档贡献指南
  • 贡献目录:按sig成员意见提交至指定目录,可参考已有文件放置规则。
  • PR提交:通过git命令提交目标分支PR,检查PR标题是否清晰、PR描述是否规范(指明更改内容和原因、是否关联对应Issue)、是否签署CLA。

4. CI门禁

通过评论 compile 指令触发开源仓门禁,并依据CI检测结果进行修改,目前CI门禁包含以下检查项:

  • 代码编译
  • 静态检查(如涉及codecheck误报,请提交给sig成员屏蔽)
  • UT测试
  • 冒烟测试

门禁通过后,请在关联的Issue中@指派的Committer。

5. Committer检视

Committer检视后将反馈检视意见,请根据意见修改,完成后@指派的Committer。

6. Maintainer合入

Committer检视通过后,标注 /lgtm标签。Maintainer将在1天内进行最终审核,确认无问题后,将标注 /approve 标签合入PR。

贡献场景

Bug修复

如果您在本项目中发现了某些Bug,希望对其进行修复,欢迎您新建Issue进行反馈和跟踪处理。

您可以按照提交Issue/处理Issue任务指引新建 Bug-Report|缺陷反馈 类Issue对Bug进行描述,然后在评论框中输入“/assign”或“/assign @yourself”,将该Issue分配给您进行处理。

软件优化

如果您对本项目中某些实现有泛化性增强/性能优化思路,希望着手实现这些优化点,欢迎您对代码进行优化贡献。

您可以按照提交Issue/处理Issue任务指引新建 Requirement|需求建议 类Issue对优化点进行说明,并提供您的设计方案,然后在评论框中输入“/assign”或“/assign @yourself”,将该Issue分配给您进行跟踪优化。

文档纠错

如果您在本项目中发现某些算子文档描述错误,欢迎您新建Issue进行反馈和修复,文档规范参考文档贡献指南

您可以按照提交Issue/处理Issue任务指引新建 Documentation|文档反馈 类Issue指出对应文档的问题,然后在评论框中输入“/assign”或“/assign @yourself”,将该Issue分配给您纠正对应文档描述。

帮助解决他人Issue

如果社区中他人遇到的问题您有合适的解决方法,欢迎您在Issue中发表评论交流,帮助他人解决问题和痛点,共同优化易用性。

如果对应Issue需要进行代码修改,您可以在Issue评论框中输入“/assign”或“/assign @yourself”,将该Issue分配给您,跟踪协助解决问题。