已合并
【PR】: 在 contributing 中提醒开发者通过 pre-commit 做代码格式化,避免流水线报错 #1367
【PR】: 在 contributing 中提醒开发者通过 pre-commit 做代码格式化,避免流水线报错 #1367
已合并
shengnan创建于 7月20日
shengnan成员
7月20日

Pull Request

描述

在 contributing 中提醒开发者通过 pre-commit 做代码格式化,避免流水线报错

变更类型

请选择本次引入的变更类型:

关联的Issue

如何测试

描述测试此变更的步骤和前提条件:
1.
2.

核对清单

其他信息

在此添加任何其他关于本次 PR 的说明。

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 shengnan 的贡献)
Sshengnan成员
7月20日 添加了label:enhancement
Sshengnan成员
7月20日 创建了 pull request,commit f68a6cb1
atomgit-bot
atomgit-bot
7月20日 评论:

变更摘要

此 PR 为纯文档更新,主要修改 CONTRIBUTING.md 贡献指南,新增关于通过 pre-commit 进行代码格式化的提醒说明,以帮助开发者在提交代码前自动完成格式化,避免因格式不符合规范而导致 CI 流水线报错。共涉及 2 个文件,新增 8 行、删除 6 行。

主要改动

  • CONTRIBUTING.md 更新:在贡献指南中增加了使用 pre-commit 工具进行代码格式化的提示内容,引导开发者在提交前自动执行格式化检查与修正。
  • 相关配置文件调整:第二个变更文件(推测为 pre-commit 相关配置)对部分内容做了微调(+8/-6),以配合文档中的指引说明,确保 pre-commit 相关描述与实际配置一致。
likedislike
atomgit-bot
atomgit-bot
7月20日 评论:

代码审查

我已经完成了对两个变更文件的详细审查。以下是我的分析过程和结论。


审查分析

CONTRIBUTING.md 变更分析

  1. 新增第4条(第24行):新增关于流水线 code check 和 pre-commit/clang-format 的说明,提醒开发者安装 pre-commit 并执行 pre-commit install
  2. 原第4条→第5条(第25行):原 rebase 相关条目序号后移,内容不变。
  3. 第60→61行:移除空行的尾部空格。
  4. 第65→66行:移除行尾空格并补充文件末尾换行符。

CONTRIBUTING_en.md 变更分析

与中文版完全对应的同类变更。

安全审查结论

  • pre-commit install:标准 git hook 安装命令,仅在开发者本地仓库生效,无安全风险。
  • 无危险指令:未引入 chmod 777、禁用 TLS、暴露 0.0.0.0、写入明文密钥等不安全操作。
  • 无供应链风险:pre-commit 和 clang-format 是业界标准开发工具。
  • 无测试/部署误导:未添加可能隐藏失败或误导验证的测试步骤。

内容一致性

  • 仓库中存在 .pre-commit-config.yaml(由 AGENTS.md 第96行确认),且有详细的中英文 pre-commit 使用指南(docs/zh/precommit_guide.mddocs/en/precommit_guide.md),新增的指引内容与现有设施一致。
  • 中英文版本内容对应准确,序号变更有序,没有发现对外部引用造成断裂。
  • 尾部空格清理和文件末尾换行符补充属于良性格式化改进。

关闭总结

  • P0: 0
  • P1: 0
  • P2: 0
  • P3: 0

已审查文件

  • CONTRIBUTING.md — 无问题
  • CONTRIBUTING_en.md — 无问题

整体风险判断:本次变更为纯文档更新,内容准确、安全,无任何正确性、安全性、可靠性或破坏性变更风险。建议合入。

⚠️ 已识别出整体风险,但无法提取行内评论,请参考整体评估。

likedislike
shengnan成员
7月20日 评论:

compile

likedislike
CANN-robotCANN-robot成员
7月20日 添加了label:cann-cla/yes
Sshengnan成员
7月20日 update merge request[project id: 8005834, iid: 1367, commit_id: 004c063b65b614caa5a207df2134b62bf2ac0562] virtual merging success
CANN-robot
CANN-robot成员
7月20日 评论:

CLA Signature Pass

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

likedislike
CANN-robot
CANN-robot成员
7月20日 评论:

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


PR Approval Progress

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

Module Approval Details

module lgtm status approve status
repo-cann/graph-autofusion zhanj, xchu42, zhang_shengjie (3/2) zhanj (1/1)

💡 Tip:

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

CLA Signature Pass

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

likedislike
CANN-robotCANN-robot成员
7月20日 将yangyongqiang0606,xchu42,zhang_shengjie,depeng1994,wqtshg_wt,peiyang,XuebinYang,sjtulxh,zhanj,zhujingjing,xuyafei,wangxiaotian995设为评审人
CANN-robotCANN-robot成员
7月20日 将yangyongqiang0606,xchu42,zhang_shengjie,depeng1994,wqtshg_wt,peiyang,XuebinYang,sjtulxh,zhanj,zhujingjing,xuyafei,wangxiaotian995设为审查人
xchu42
xchu42成员
7月20日 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
7月20日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
7月20日 评论:

流水线任务触发成功
任务链接 [da17dae09c204f9f85ab5cbb24463e3d][流水线指导]

任务名称状态日志下载链接
codecheck ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_checkpr ✅ SUCCESS
pre_comment ✅ SUCCESS >>>>>
codecheck_codestyle ✅ SUCCESS >>>>>
codecheck_precommit ❌ FAILED >>>>> >>>>>
likedislike
CANN-robot
CANN-robot成员
7月20日 评论:

流水线任务触发成功
任务链接 [59b55f3a7d694de8a8a4f59c8c65cbaa][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>

[2026-07-20 19:54:38]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月20日 评论:

流水线任务触发成功
任务链接 [6a25ce16712240ae93211a8c38d2b8ef][流水线指导]

任务名称状态日志下载链接
UT_Test_Python_superkernel ✅ SUCCESS >>>>>
ST_Test_Python_superkernel ✅ SUCCESS >>>>>
UT_Test_superkernel ✅ SUCCESS >>>>>
UT_Test_autofuse_framework ✅ SUCCESS >>>>>
ST_Test_autofuse_framework ✅ SUCCESS >>>>>
UT_Test_autofuse_ascendc_api ✅ SUCCESS >>>>>
ST_Test_autofuse_ascendc_api ✅ SUCCESS >>>>>
ST_Test_autofuse_e2e ✅ SUCCESS >>>>>
pre_comment ✅ SUCCESS >>>>>

[2026-07-20 19:47:39]    CI执行结束

likedislike
zhang_shengjie成员
7月20日 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
7月20日 添加了label:lgtm
此处折叠了5条事件消息 查看更多
CANN-robotCANN-robot成员
7月20日 删除了label:lgtm
CANN-robot
CANN-robot成员
7月20日 评论:

Notice

New code changes of the pull request are detected and remove these labels lgtm. 😳

likedislike
shengnan成员
7月20日 评论:

compile

likedislike
Sshengnan成员
7月20日 update merge request[project id: 8005834, iid: 1367, commit_id: 25e0a6c52572109de259f98e811de9308607703a] virtual merging success
CANN-robotCANN-robot成员
7月20日 删除了label:ci-pipeline-failed
CANN-robotCANN-robot成员
7月20日 添加了label:ci-pipeline-running
CANN-robot
CANN-robot成员
7月20日 评论:

流水线任务触发成功
任务链接 [d5e50d452eb84e10a90a73d8b33751e6][流水线指导]

任务名称状态日志下载链接
UT_Test_Python_superkernel ✅ SUCCESS >>>>>
ST_Test_Python_superkernel ✅ SUCCESS >>>>>
UT_Test_superkernel ✅ SUCCESS >>>>>
UT_Test_autofuse_framework ✅ SUCCESS >>>>>
ST_Test_autofuse_framework ✅ SUCCESS >>>>>
UT_Test_autofuse_ascendc_api ✅ SUCCESS >>>>>
ST_Test_autofuse_ascendc_api ✅ SUCCESS >>>>>
ST_Test_autofuse_e2e ✅ SUCCESS >>>>>
pre_comment ✅ SUCCESS >>>>>

[2026-07-20 20:03:38]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月20日 评论:

流水线任务触发成功
任务链接 [9b870a03de9e426e91ab9667949d8b55][流水线指导]

任务名称状态日志下载链接
codecheck ✅ SUCCESS >>>>>
SCA ✅ SUCCESS >>>>>
antipoison ✅ SUCCESS >>>>>
codecheck_checkpr ✅ SUCCESS
pre_comment ✅ SUCCESS >>>>>
codecheck_codestyle ✅ SUCCESS >>>>>
codecheck_precommit ✅ SUCCESS >>>>>

[2026-07-20 20:05:01]    CI执行结束

likedislike
CANN-robot
CANN-robot成员
7月20日 评论:

流水线任务触发成功
任务链接 [013807da2e294103b47c084cb85653e5][流水线指导]

任务名称状态日志下载链接
Compile_Ascend_X86 ✅ SUCCESS >>>>> >>>>>
Compile_Ascend_ARM ✅ SUCCESS >>>>> >>>>>
pre_comment ✅ SUCCESS >>>>>
PreSmoke_A900_npupool ✅ SUCCESS >>>>>

[2026-07-20 20:10:42]    CI执行结束

likedislike
CANN-robotCANN-robot成员
7月20日 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
7月20日 添加了label:ci-pipeline-passed
xchu42
xchu42成员
7月20日 评论:

/lgtm

likedislike
zhang_shengjie成员
7月20日 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
7月20日 添加了label:lgtm
zhanj
zhanj成员
7月20日 评论:

/approve

likedislike
CANN-robotCANN-robot成员
7月20日 添加了label:approved
CANN-robotCANN-robot成员
7月20日 合入了pull request