CANN/cannbot-skills AscendC代码审查报告撰写指南

撰写报告(文件检视 + PR 检视)

【免费下载链接】cannbot-skills CANNBot 是面向 CANN 开发的用于提升开发效率的系列智能体,本仓库为其提供可复用的 Skills 模块。 【免费下载链接】cannbot-skills 项目地址: https://gitcode.com/cann/cannbot-skills

执行步骤

  1. 按置信度分级汇总:

    • HIGH →「发现问题」
    • MED →「需关注」
    • LOW →「疑似」
  2. 生成报告文件

报告格式

文件检视报告

路径:./operators/{operator_name}/{source_file}_review_summary.md

# 代码检视报告

## 检视概览
- 代码文件:{path}
- 代码侧别:{Kernel/Tiling}
- 检视文档:{doc_list}
- 总条例数:{total}
- 检视时间:{timestamp}

## 检视统计
| 状态 | 条例数 | 占比 |
|------|------|------|
| PASS | {n} | {pct} |
| FAIL(发现问题)| {n} | {pct} |
| SUSPICIOUS(需关注)| {n} | {pct} |

## 发现问题(HIGH 置信度)
### [{条例ID}] {标题}
- **问题描述**:{描述}
- **代码片段**({完整文件路径} 行 {start}-{end}):
  ```cpp
  {至少 10 行代码,含上下文}
  • 假设检验证据

正向证据: | 证据类型 | 分值 | 证据描述 | |---------|------|---------| | {类型} | {+X%} | {描述} |

负向证据: | 证据类型 | 分值 | 证据描述 | |---------|------|---------| | {类型} | {-X%} | {描述} |

自信值 = Σ正向 + Σ负向 = {累计}% ≥ 70% → 判定违规

  • 修复建议:{建议}

需关注(MED 置信度)

(同上格式)

疑似(LOW 置信度)

(同上格式)

通过条例

{通过条例 ID 列表,每行一条}


### PR 检视报告

路径:`./operators/pr-{pr_number}/{pr_number}_review_summary.md`
格式同文件检视报告。

## 约束

- 每个 FAIL/SUSPICIOUS 发现必须附 10 行以上代码片段
- 行号必须使用校对后的结果
- PR 检视报告的代码片段必须标注完整文件路径(相对于 repo_path),禁止只写短文件名

【免费下载链接】cannbot-skills CANNBot 是面向 CANN 开发的用于提升开发效率的系列智能体,本仓库为其提供可复用的 Skills 模块。 【免费下载链接】cannbot-skills 项目地址: https://gitcode.com/cann/cannbot-skills

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值