Closed
[Documentation|文档反馈]: CONTRIBUTING.md 标题手工添加序号,不符合文档规范 #431
廖氏如神Add on  Sep 20Closed at  Sep 30
廖氏如神
廖氏如神
Sep 20 Create

问题描述

CONTRIBUTING.md 中多处章节标题手工添加了序号,不符合《文档写作规范》对标题的要求:

### 1. 创建Issue需求
### 2. 需求评审
### 3. PR提交

(另见 CONTRIBUTING_en.md 等处是否同样存在,建议一并核对。)

影响分析

  1. 手工序号在章节增删时需人工重排,易跳号、重号;
  2. 含序号锚点在章节重排后失效,文档内引用易断链。

修复建议

移除标题中手工添加的序号,保留标题文字。

问题复现方式

git clone --depth 1 https://gitcode.com/cann/opbase.git
cd opbase
grep -nE '^#{1,6} +[0-9]+[.、]' CONTRIBUTING.md

影响级别

L1:标题格式类问题。

likedislike
ren-botaoCollaborators
Sep 20 Comments:

感谢您对CANN社区做出的贡献,我们正在确认CANN文档整体规范。

likedislike
songkai111Collaborators
Sep 29 Comments:

你好,如果不用小标号,有其他好办法来区分小标题嘛?

likedislike
陈思
陈思
Sep 30 Comments:

/assign @songkai111

likedislike
CANN-robotCANN-robotCollaborators
Sep 30 Assign songkai111 as responsible person
CANN-robotCANN-robotCollaborators
Sep 30 Close issue
CANN-robotCANN-robotCollaborators
Sep 30 Added label: resolved