Merged
docs: CONTRIBUTING新增算子分类与贡献区别章节,补充生态算子覆盖率与用例上库要求 #14305
docs: CONTRIBUTING新增算子分类与贡献区别章节,补充生态算子覆盖率与用例上库要求 #14305
Merged
wang-minboAdd on 18 days ago
wang-minboCollaborators
18 days ago

描述

关联的Issue

https://gitcode.com/cann/ops-transformer/issues/6942

测试

文档更新

类型标签

likedislike
Pull Request has been successfully merged by CANN-robot.
(Thank you for wang-minbo's contribution.)
Wwang-minboCollaborators
18 days ago Created pull request, commit 9cc294be
atomgit-bot
atomgit-bot
18 days ago Comments:

变更摘要

本 PR 为文档更新,在 CONTRIBUTING.md 中新增「算子分类与贡献区别」章节,明确 built-in 算子(非 experimental 算子)与 experimental 生态算子的定位、贡献目录、交付件与评审重点差异,并补充生态算子的覆盖率要求与定制场景用例上库要求。同时将原文中「项目标准算子」统一表述为「built-in 算子」,并在 CI 门禁说明中补充覆盖率统计。

主要改动

  • 新增算子分类章节: 在 CONTRIBUTING.md 中新增「算子分类与贡献区别」,说明 built-in 算子面向主流模型场景、支持商用、贡献目录直接位于算子分类目录(如 attention/、moe/、mc2/),experimental 生态算子位于 experimental/${op_class}、支持定制算法快速验证且不作商用承诺。
  • 新增贡献要求对比表: 以表格形式从目标场景、使用方式、贡献目录、交付件要求、评审重点等维度对比 built-in 算子与 experimental 生态算子,明确前者需完整交付件、后者支持最简交付件。
  • 补充覆盖率与用例上库要求: 在生态算子交付件要求中新增「覆盖率要求」和「用例上库要求」两行,说明测试文件需覆盖核心功能与主要分支,本地可通过 bash build.sh -u --cov 生成 lcov 报告自查,CI 按 tests/test_config.yaml 统计覆盖率,定制场景用例须上库至算子 tests 目录。
  • 统一 built-in 术语表述: 将原「项目标准算子」相关表述改为「项目标准算子(built-in 算子)」,涉及附录标题及生态贡献场景中的注意说明。
  • 更新 CI 门禁说明: 将门禁中的「UT 测试」补充为「UT 测试(含覆盖率统计)」。

🧩 本次 Review 已使用自定义 Skill:

likedislike
Incorrect?
CANN-robotCANN-robotCollaborators
18 days ago Added label: cann-cla/yes
CANN-robot
CANN-robotCollaborators
18 days ago Comments:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here.
You can get sig-info at here.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.


PR Approval Progress

✅ Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
CONTRIBUTING.md ✅ 刘丹, 蒋礼锐 (2/2) ✅ 刘丹, 蒋礼锐 (2/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

wang-minbo, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
CANN-robot
CANN-robotCollaborators
18 days ago Comments:

CLA Signature Pass

wang-minbo, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
127 messages are collapsed here。 See more
CANN-robotCANN-robotCollaborators
6 days ago Merged pull request
CANN-robotCANN-robotCollaborators
6 days ago Removed label: ci-pipeline-passed
CANN-robotCANN-robotCollaborators
6 days ago Added label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
6 days ago Removed label: ci-pipeline-running
CANN-robotCANN-robotCollaborators
6 days ago Added label: ci-pipeline-passed