规则¶
结构¶
规则由 common 层和 语言特定 目录组成:
rules/
├── common/ # 言語に依存しない原則(常にインストール)
│ ├── coding-style.md
│ ├── git-workflow.md
│ ├── testing.md
│ ├── performance.md
│ ├── patterns.md
│ ├── hooks.md
│ ├── agents.md
│ └── security.md
├── typescript/ # TypeScript/JavaScript 固有
├── python/ # Python 固有
└── golang/ # Go 固有
- common/ 包含通用原则。不包含语言特定的代码示例。
- 语言目录 使用框架特定的模式、工具和代码示例扩展 common 规则。每个文件都引用对应的 common 文件。
安装¶
选项 1:安装脚本(推荐)¶
# common + 1つ以上の言語固有ルールセットをインストール
./install.sh typescript
./install.sh python
./install.sh golang
# 複数の言語を一度にインストール
./install.sh typescript python
选项 2:手动安装¶
重要: 请复制整个目录。不要使用
/*将其扁平化。 common 目录和语言特定目录中包含同名文件。 如果将它们扁平化到一个目录中,语言特定文件会覆盖 common 规则, 并且语言特定文件使用的相对路径../common/引用会失效。
# common ルールをインストール(すべてのプロジェクトに必須)
cp -r rules/common ~/.claude/rules/common
# プロジェクトの技術スタックに応じて言語固有ルールをインストール
cp -r rules/typescript ~/.claude/rules/typescript
cp -r rules/python ~/.claude/rules/python
cp -r rules/golang ~/.claude/rules/golang
# 注意!実際のプロジェクト要件に応じて設定してください。ここでの設定は参考例です。
规则 vs 技能¶
- 规则 定义广泛适用的标准、约定和检查清单(例如:“80% 测试覆盖率”、“无硬编码密钥”)。
- 技能(
skills/目录)为特定任务提供详细且可执行的参考资料(例如:python-patterns、golang-testing)。
语言特定的规则文件会按需引用相关技能。规则说明做什么,技能说明怎么做。
添加新语言¶
要添加对新语言(例如:rust/)的支持:
- 创建
rules/rust/目录 - 添加扩展 common 规则的文件:
coding-style.md— 格式化工具、惯用法、错误处理模式testing.md— 测试框架、覆盖率工具、测试配置patterns.md— 语言特定的设计模式hooks.md— 用于格式化器、代码检查器、类型检查器的 PostToolUse 钩子security.md— 密钥管理、安全扫描工具- 每个文件请以以下内容开头:
- 引用可用的现有技能,或在
skills/下创建新的技能。
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 ev/ECC