贡献指南

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

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

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

API开发指南

本项目支持API相关贡献。开发者在新增或修改API前,应先通过Issue说明使用场景、接口设计、兼容性影响和测试方案;涉及新增特性、新增接口或行为变化的修改,应在方案讨论清楚后再提交PR。

API开发类贡献主要包括:

  • 新增接口能力。
  • 修复接口缺陷。
  • 优化接口实现。
  • 补充接口测试。
  • 完善接口使用说明和样例。

资料贡献指南

本项目欢迎开发者对文档资料进行纠错、补充和优化。资料类修改应保持描述准确、结构清晰,并与代码、样例和测试行为一致。

资料贡献类场景主要包括:

  • 修正文档错误描述。
  • 补充缺失的接口约束、参数说明或返回值说明。
  • 补充构建、测试、依赖或样例说明。
  • 修复无效链接、格式问题或表述歧义。

新增或修改API文档时,请参考API文档贡献指南。新增或修改README、docs、examples等资料文档时,请参考资料贡献指南。

开发者贡献场景主要包括

  • 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分配给您,跟踪协助解决问题。