关于 setup-coding-standards
此技能根据提供的基线和代码中核实的惯例,为代码仓库创建编码规范文档。它会先检查现有文件,保留基线结构,并在写入后核对内容。
主要功能
- 01查找代码仓库根目录
- 02检查是否已有规范文件
- 03逐字复制提供的基线
- 04仅补充经代码核实的惯例
- 05回读并核对文档
适用场景
- 01为代码仓库创建编码规范
- 02记录从源代码确认的惯例
- 03避免重复创建现有规范文件
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ hu3rror/ my-skills --skill setup-coding-standards安装后在 Claude Code 中输入/setup-coding-standards确认已加载。
附带文件references/baseline.md
详细介绍
初始化仓库的编码规范
步骤
-
查找仓库根目录。 在当前工作目录运行
git rev-parse --show-toplevel;如果仓库没有 Git 根目录,则使用当前工作目录。选择好一个根目录路径后即完成。 -
检查是否已有规范文件。 在根目录查找
CODING_STANDARDS.md及名称相近的文件(coding-standards.md和大小写变体)。如果存在:停止操作,报告其路径,不写入任何内容。确认文件是否存在后即完成。 -
编写文件。 阅读此技能目录中的
references/baseline.md,并将其原样复制为文件开头;不要重命名或重组其中的标题。基线内容以一条标记注释结尾——仓库规范必须写在该标记之后,不能写在前面。然后,追加你从当前代码中核实的仓库规范:注明证据,不得臆造。注释不算证据——注释声称的规范必须对照其描述的代码进行核实,否则就应删除。对于仓库工具已经强制执行的规范,不要重复记录;格式化工具、代码检查工具或类型检查器才是这些规范的唯一依据。如果没有核实过的规范,文件就只保留基线内容。满足以下条件后即完成:基线部分与references/baseline.md完全一致;所有追加内容都位于标记之后,且已从代码中核实;没有空章节。 -
写入文件。 将文件写入仓库根目录。重新读取文件,并确认内容与编写的内容一致。文件存在且内容匹配后即完成。
-
**报告:**说明文件路径、写入的内容(仅基线,或基线加上哪些规范),并说明扩展文件只需修改一个位置:新规则都添加到这里,每条规则只保留一个归属位置。