贡献指南¶
本项目欢迎广大开发者体验并参与贡献，在参与社区贡献之前。请参见cann-community了解行为准则，进行CLA协议签署，了解源码仓的贡献流程。
开发者准备本地代码与提交PR时需要重点关注如下几点：
- 提交PR时，请按照PR模板仔细填写本次PR的业务背景、目的、方案等信息。
- 若您的修改不是简单的bug修复，而是涉及到新增特性、新增接口、新增配置参数或者修改代码流程等，请务必先通过Issue进行方案讨论，以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为“简单的bug修复”，亦可通过提交Issue进行方案讨论。
开发者贡献场景主要包括：
算子Bug修复¶
如果您在本项目中发现了某些算子Bug，希望对其进行修复，欢迎您新建Issue进行反馈和跟踪处理。
您可以按照提交Issue/处理Issue任务指引新建 Bug-Report|缺陷反馈 类Issue对Bug进行描述，然后在评论框中输入“/assign”或“/assign @yourself”，将该Issue分配给您进行处理。
算子优化¶
如果您对本项目中某些算子实现有泛化性增强/性能优化思路，希望着手实现这些优化点，欢迎您对算子进行优化贡献。
您可以按照提交Issue/处理Issue任务指引新建 Requirement|需求建议 类Issue对优化点进行说明，并提供您的设计方案，
然后在评论框中输入“/assign”或“/assign @yourself”，将该Issue分配给您进行跟踪优化。
贡献新算子¶
如果您有全新的算子希望基于 NPU 进行设计与实现，欢迎在 Issue 中提出您的想法与设计方案。完整的贡献流程如下：
#### 1. 新增 Issue
请按照提交 Issue / 处理 Issue 任务指引，新建 Requirement|需求建议 类 Issue，并在其中说明新增算子的设计方案。
Issue 需包含以下内容：
- 背景信息
- 价值/作用
- 设计方案
同时，请在提交的 Issue 中评论 /assign 或 /assign @yourself 认领该任务，以便后续完成算子上库。
#### 2. 需求评审 Sig成员将对您提交的 Issue 进行评审并给出修改意见。请在完成修改后，于 Issue 中回复：
“完成意见修改，申请复审”
若需求被接纳，sig成员将为您分配合适的算子分类路径（如：include/pto/npu/a5），以便您将新增算子提交至对应目录。
如在 Issue 交流中未能达成共识，建议申报 SIG 组双周例会，在会议中进行进一步讨论。
#### 3. 提交 PR
在方案确定后，即可开始开发工作。新增算子的交付内容可基于最小交付件结构调整，请参考以下最小交付件进行检查。其中 ${op_name} 为新增算子名称。
docs
├── isa
│ ├── ${op_name}.md # 算子说明文档
include
├── pto # 业务代码
│ ├── common # 通用目录
│ │ ├── pto_instr_impl.hpp # 算子实现文件汇总
│ │ └── pto_instr.hpp # 对外暴露接口
│ ├── ${op_class} # 算子分类
│ │ └── ${op_name}.hpp # 算子实现文件，定义算子头文件，包含函数说明、结构定义、逻辑实现
tests # 测试文件目录
├── ${op_class}/src/st/testcase # st测试目录
│ ├── ${op_name} # 单个算子st测试文件
│ │ ├── ${op_name}.cpp # 调用接口文件
│ │ ├── main.cpp # st运行主函数文件
│ │ ├── gen_data.py # st用例输入数据与预期结果生成文件
│ │ └── CMakeList.txt # 编译配置文件
│ └── CMakeList.txt # 编译配置文件
├── run_st.sh # cpu类算子st用例执行文件，添加单个用例及所有用例的执行命令
开发完成后，请检查以下内容：
- 代码交付件完整性（含 ST 测试用例代码）
- 代码符合.clang-format和pyproject.toml规范，提交前请使用命令clang-format -i -style=file <文件名>和ruff format <文件名>修复代码规范问题
- PR 是否已关联对应 Issue
- 是否签署 CLA
- 通过评论 compile 指令触发开源仓门禁，并依据 CI 检测结果进行修改。如涉及codecheck误报，请提交给sig成员屏蔽。
门禁通过后，请在关联的 Issue 中回复：
"该 Issue 关联的 PR：XXX，请尽快评审"
Sig成员检视后将反馈检视意见，请完成所有修改后回复：
"该 Issue 关联的 PR：XXX，已完成 PR 问题整改，请尽快评审"
#### 4. PR 上库
Committer 检视通过后，Maintainer 将进行最终审核。确认无误后，将标注 /lgtm 和 /approve 标签合入PR。
文档纠错¶
如果您在本项目中发现某些算子文档描述错误，欢迎您新建Issue进行反馈和修复。
您可以按照提交Issue/处理Issue任务指引新建 Documentation|文档反馈 类Issue指出对应文档的问题，然后在评论框中输入“/assign”或“/assign @yourself”，将该Issue分配给您纠正对应文档描述。
帮助解决他人Issue¶
如果社区中他人遇到的问题您有合适的解决方法，欢迎您在Issue中发表评论交流，帮助他人解决问题和痛点，共同优化易用性。
如果对应Issue需要进行代码修改，您可以在Issue评论框中输入“/assign”或“/assign @yourself”，将该Issue分配给您，跟踪协助解决问题。