贡献指南

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

期望的贡献

问题修复：修复自己发现的或在Issue列表中的Bug，比如代码中的逻辑错误、内存泄漏或崩溃等问题；
社区任务：领取HCCL社区公布的任务；
性能优化：针对特定算子或特定架构的性能优化；
新功能支持：增加平台功能、新算子或新业务场景的支持；
文档优化：改进文档、注释或使用用例。

预备知识

编码规范

请遵从CANN 社区编码规范。

PR规范

提交 PR 时，请按照 PR 模板仔细填写本次 PR 的业务背景、目的、方案等信息；
所有PR都必须关联Issue，请在PR描述中引用对应的Issue编号；
使用 Git 提交代码前，请参考 pre-commit工具使用指导，以保持代码风格一致且符合合规规范。
若您的修改不是简单的 bug 修复，而是涉及到新增特性、新增接口、新增配置参数或者修改代码流程等，请务必先通过 Issue 进行方案讨论，以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为"简单的 bug 修复"，亦可通过提交 Issue 进行方案讨论。

贡献流程

贡献可以分为两类：

简单问题处理：Bug修复、简单代码修改、文档修改等；
新功能或新特性：增加新功能、新特性、新接口，或者支持新业务场景的贡献。

整体流程

flowchart TD
    A1[开始贡献] --> A2{类型?}
    A2 -->|简单问题| A3[查询Issue列表]
    A2 -->|新功能/特性| A4[提交Requirement类型Issue]

    A3 --> A5{已有Issue?}
    A5 -->|有| A6[认领该Issue]
    A5 -->|无| A7[创建Issue并认领]
    A7 --> A6
    A6 --> A19

    A4 --> A10{SIG组决策}
    A10 -->|拒绝| A11[关闭Issue]
    A10 -->|接纳| A12[添加accepted标签]
    A12 --> A13[设计系统方案]
    A13 --> A14[编写/修改RFC]
    A14 --> A15[提交包含RFC的PR]
    A15 --> A16{Maintainer评审}
    A16 -->|提出意见| A14
    A16 -->|通过| A17[合入RFC]
    A17 --> A19[修改/实现代码，提交PR]

    A19 --> A20{Committer检视}
    A20 -->|检视意见| A21[修改]
    A21 --> A20
    A20 -->|通过| A24[合入PR]

简单问题处理

查询并认领Issue
- 现在Issue列表中查询该问题是否有对应的Issue；
- 如有对应Issue：直接认领该Issue；
- 如无对应Issue：创建新的Issue并认领。
修改代码并提交PR
- 需要满足编码规范与PR规范；
- 确保包含触发Bug的回归测试。
代码评审与合入
- 负责对应模块或组件的Committer检视代码并反馈检视意见，请根据意见修改；没有问题后，添加/lgtm和/approve标签并合入。

增加新功能或新特性

提交Requirement类型Issue
- 在代码仓提交Requirement类型的Issue；
- 详细描述：使用场景、业务价值、大致技术方案；
- 在社区发起讨论，SIG组决策是否接纳该需求；如果接纳，添加accepted标签。
系统方案设计
- 需求被接纳后，设计详细的系统方案；
- 在 docs/rfcs 目录下创建markdown格式的RFC文件，并按RFC模板撰写系统方案；
- 提交PR。
系统方案评审
- 详细设计方案通过包含RFC的PR进行评审；
- 过程中请针对评审意见进行方案修改；
RFC合入
- 所有Maintainer对方案均无异议后，由Maintainer添加/lgtm和/approve标签合入；
- 合入的RFC方案作为后续代码实施的合约，代码实现需要遵循RFC方案。
软件实现
- 按照RFC方案实现代码，并提交PR；
- 必须包含对应的测试代码（包含单元测试与系统测试）。
代码评审与合入
- 负责对应模块或组件的Committer检视代码并反馈检视意见，请根据意见修改；没有问题后，添加/lgtm和/approve标签并合入。

争议处理

存在争议的Issue、PR或RFC可以在SIG工作会议上申报议题，由SIG组决策。

本文档由社区维护，如有变更建议，请在Issue中提出。