SuperAPI AI 工具集

claude-rules

编程与开发

查看项目

更新于 10-16 03:13

技能介绍

用途:在 .claude/rules/ 中创建可复用的项目约定文件,把格式化、测试、提交、架构、安全等约定从 CLAUDE.md 中分离出来,按需引用。

主要能力:区分 CLAUDE.md 与 rules/ 的定位。CLAUDE.md 在会话开始时自动加载,内容为项目设置、关键命令、文件位置,篇幅约 200-500 行;rules/ 按需通过引用加载,可写更详细的跨文件模式。

文件约定:文件名用大写加 .md 扩展名,一个文件聚焦一个主题,多词用 kebab-case,如 FORMATTING.md、TESTING.md、COMMITS.md、ARCHITECTURE.md、SECURITY.md。内容应便于扫读,使用表格、Do/Don't 列表和具体示例。

使用方式:在 CLAUDE.md 中显式引用规则文件,例如“Follow .claude/rules/FORMATTING.md for all code conventions.”。跨文件引用可用 @ 语法,如 @./project-specific/FORMATTING.md,以保持规则 DRY。插件内部可组织共享规则,但共享规则仅在单个插件内有效;插件安装后会被复制到缓存目录,跨出插件根目录的路径(如 ../other-plugin/rules/)将失效。跨插件模式应改用技能调用,按名称引用相关技能而非文件路径。

适用场景:需要统一团队或项目的代码风格、测试模式、提交信息格式、架构约定时。

限制:规则不会自动加载,必须被引用;不要为一次性指令创建规则文件,不要与 CLAUDE.md 内容重复,不要创建 EVERYTHING.md 这类笼统文件。相关技能包括 claude-code-configuration 与 claude-plugin-development。