关于 rule
rule 是一项编码技能,可将用户明确的纠正或要求整理为简短书面规则,并查找和修复现有违规。它还规定了规则检查的报告方式。
主要功能
- 01先读取现有项目规则
- 02用修改前后示例编写简短规则
- 03每条规则仅保存在所属文件
- 04查找并修复现有违规
- 05按严重程度报告问题
适用场景
- 01将重复的代码纠正记录为规则
- 02添加用户提出的始终或禁止要求
- 03依据书面规则检查代码库
- 04查找并修复违反新规则的代码
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ raphaelsalaja/ skills --skill rule安装后在 Claude Code 中输入/rule确认已加载。
附带文件agents/openai.yaml
详细介绍
规则
这项技能会将一次纠正转化为书面规则。它会在合适的文件中写入一次规则,然后修复已经违反规则的代码。
违反两次就该立规则
用户说“把它立为规则”“始终”“绝不”或“记住这点”时,就把它写下来。同一件事被纠正两次时,提出一条规则。规则应由一组短句组成,短到每次编辑前都能读一遍。
编辑时遵循规则属于 scope。对照所有规则审查代码库属于 audit。
1. 阅读现有规则
行动前阅读 AGENTS.md、CLAUDE.md 和编辑器规则目录。违反书面规则采取行动属于 rule-read-before-acting。
2. 写出这一组短句
用一句话说明规则,然后写出违反规则的代码行和替换它的代码行。没有示例的规则属于 rule-write-the-pair。
3. 保持简短
一条规则由一到三句话及其对应短句组成。大段推理说明属于 rule-keep-it-short。
4. 只设一个归属文件
将规则放入负责其主题的文件中。将同一规则复制到第二个文件属于 rule-one-home。新规则与旧规则冲突时,替换旧规则并说明。两条互相矛盾的规则并列存在属于 rule-resolve-conflicts。
5. 扫查代码
搜索违反新规则的代码,修复并列出相关文件。写下规则却保留旧违规代码属于 rule-sweep-existing。
这一组短句
每项检查都由一组短句构成。违反规则的代码行紧挨着替换它的代码行。
| 规则 | 违反规则的写法 | 替换写法 |
|---|---|---|
rule-read-before-acting | 在规则禁止使用胶囊按钮的仓库中添加胶囊按钮 | 先读规则,再使用圆角按钮 |
rule-write-the-pair | “使用合适的大小写” | “标签使用标题式大小写。Add to library 改为 Add to Library” |
rule-keep-it-short | 大段推理说明 | 一句话和一组短句 |
rule-one-home | 在三个文件中写入同一规则 | 只写入一个文件,其他文件指向该文件 |
rule-resolve-conflicts | 并列写着“使用边框”和“绝不使用边框” | 替换旧规则,并注明变更 |
rule-sweep-existing | 添加了规则,却留下十二处违规 | 修复并列出违规项 |
报告
严重性。 HIGH 表示编辑违反了书面规则,或两条规则互相矛盾。MEDIUM 表示规则缺少对应短句,或新增规则后仍留下旧违规。LOW 表示规则篇幅过长。
格式。 每个根本原因对应一项发现:
file:line - [rule-id] what is wrong
然后提供 Rule | Count | Severity 汇总。仍有任何 HIGH 时标记为 Block,否则标记为 Approve。将所有无法读取的规则文件标记为 Not verified。