This repository has been archived on 2026-07-15. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
ClaudeInit/.claude/rules/common/baserule.md
2026-04-24 16:42:22 +08:00

2.6 KiB
Raw Permalink Blame History

语言约定

Agent 回复时使用简体中文。 代码注释时尽量使用简体中文。 写 SKILL 的时候文档部分也尽量使用简体中文。 专业术语和项目专有名词不受此语言限制,通常是英文则保留(如 frontmatterhooktokenMCPClaude CodeGitHub 等)。

Rules / Skills 目录归属约定

本项目使用以下目录结构区分跨项目通用内容与项目专属内容:

Rules

目录 用途 示例
.claude/rules/common/ 跨项目通用规则,开新项目时可直接复制 语言约定、init 触发、changelog 调用
.claude/rules/project/ 当前项目专属规则 项目架构约定、框架特定规范、项目专属工作流

Rules 的引入通过主 CLAUDE.md@import 语法进行,每条规则独立一个文件。

Skills

位置 用途 示例
.claude/skills/ 所有 Skill 的主存储位置(含通用和项目专属) claude-init、dev-changelog、项目特定 Skill
~/.claude/skills/ 跨项目通用 Skill 的全局副本(可选,方便其他项目复用) claude-init、dev-changelog

重要:无论 Skill 是通用还是项目专属,都必须在项目的 .claude/skills/ 下保留一份, 以确保能被 Git 管理和版本控制。全局目录 ~/.claude/skills/ 仅作为跨项目共享的便利副本, 不作为唯一存储位置。

Agent 创建 Rule 或 Skill 时必须遵守

  1. 先判断归属:新建 Rule 或 Skill 前,评估其是否为跨项目通用内容
  2. 如果不确定,必须询问用户"这个 Rule/Skill 是通用的还是项目专属的?"
  3. 确认后放入对应目录:
    • 通用 Rule → .claude/rules/common/<name>.md + 在 CLAUDE.md 的"引入的规则"段追加 @import
    • 项目专属 Rule → .claude/rules/project/<name>.md + 在 CLAUDE.md 的"项目专属规则"段追加 @import
    • 所有 Skill含通用.claude/skills/<skill-name>/SKILL.md(必须,确保 Git 可管理)
    • 通用 Skill 额外同步 → ~/.claude/skills/<skill-name>/SKILL.md(可选,方便其他项目使用)

Skill 的 frontmatter 规范

新建 Skill 时 SKILL.md 的 YAML frontmatter 必须符合 Claude Code 官方规范:

  • name: 最多 64 字符,仅小写字母/数字/连字符,不含保留词 anthropicclaude
  • description: 最多 1024 字符,非空,第三人称,包含"做什么 + 何时使用"的触发关键词

详见 Anthropic 官方文档:https://code.claude.com/docs/en/skills