CLAUDE.md 是 Claude Code 会在会话中读取的项目指令文件。它适合记录每次都要重复说明的稳定规则,而不是把所有文档塞进上下文。
先写最小版本
在仓库根目录新建 CLAUDE.md,先只写团队已经确认的事实。规则至少写清常用命令、允许修改的目录和完成标准。

# 项目约定
- 安装依赖:npm ci
- 单元测试:npm test -- --runInBand
- 格式检查:npm run lint
- 业务代码只在 src/ 下修改
- 不修改 migrations/ 和 production/
- 完成标准:相关测试通过,并列出实际改动文件
规则要能被执行
“写好代码”“注意质量”无法验收。应改成具体命令、目录和结果。例如说明使用哪个包管理器、不得新增依赖、数据库变更必须先征求确认。项目规则应提交到版本库;仅适合个人的偏好放在用户级文件。
分层组织
根目录放全项目规则;子目录可放更具体的 CLAUDE.md;个人通用习惯可放在用户目录。规则发生冲突时,先查实际加载来源,再删除重复或互相矛盾的表述。
验证是否生效
新开一个会话,让 Claude 复述测试命令和禁止修改目录,再给一项小任务检查是否遵守。最后用 git diff 核对没有改到禁止目录,并确认它运行的是文件中写明的测试。
不要把密钥、口令、临时任务或几十页架构资料写进 CLAUDE.md。过长的常驻内容会占用上下文;专门流程更适合按需加载的 Skill 或独立文档。
资料与适用范围
文件范围与加载方式依据 官方 Memory/CLAUDE.md 文档及常用工作流。示例命令是演示,必须换成仓库真实命令后再使用。
Ai菜鸟网。发布者:AI小管家,转载请注明出处:https://www.alyyhw.com/30866.html