已关闭
[Documentation|文档反馈]: 建议在 README.md 的“源码下载”章节补充具体的 tag_version 示例 #2489
理亏亏创建于  5月5日关闭于  6月3日
理亏亏
5月5日 创建

Thanks for sending an issue! Please fill in the following template to help quickly solve your problem.

Document Link(文档链接)

https://gitcode.com/cann/ops-nn/blob/master/README.md

Issues Section(问题文档片段)

⬇️源码下载

环境准备好后,下载与CANN版本配套的分支源码,命令如下,${tag_version}替换为分支标签名。

说明:若环境中已存在配套分支源码,可跳过本步骤,例如WebIDE默认已提供最新商发版CANN对应的源码。

git clone -b ${tag_version} https://gitcode.com/cann/ops-nn.git
### Existing Issues(存在的问题)
            
当前在 README.md 的“源码下载”章节中,提示开发者将 `${tag_version}` 替换为分支标签名。

存在的问题:
虽然上方“版本配套”章节提到了可以去 release 仓库查看对应关系,但对于刚接触 CANN 算子开发的新手而言,往往不清楚 tag 的具体命名规范和格式(例如,是不带前缀的 `8.0.0`,还是带前缀的 `v8.0.rc1` 等)。这可能导致新手在执行 clone 命令时报错并产生困惑。

改进建议:
建议在 `${tag_version}` 的说明下方,补充一个具体的、可以直接运行的命令示例。例如:
“例如,若要下载 xxx 版本的源码,可执行:
`git clone -b v8.0.0 https://gitcode.com/cann/ops-nn.git`”

这样能直观展示 tag 的格式,进一步降低零基础开发者的入门门槛,提升快速入门(QuickStart)的体验。
likedislike
oscillatedoscillated成员
5月6日 将 gitcode-chenjiao 设为负责人
oscillated
oscillated成员
5月6日 评论:

您好,问题已收到,已安排对应负责人。

likedislike
Cchenjiao成员
6月3日 关联了pull request:fix doc issues
oscillatedoscillated成员
6月3日 删除了关联的pull request:fix doc issues
CANN-robotCANN-robot成员
6月3日 关闭了 issue
CANN-robotCANN-robot成员
6月3日 添加了label:resolved
Cchenjiao成员
6月4日 关联了pull request:内容一致性低错修改