awesome-claude-md

> CLAUDE.md 最佳实践集合 — 让你的 AI 编程助手真正理解你的项目

🌐 简体中文 | English

[](https://github.com/jnMetaCode/awesome-claude-md) [](https://opensource.org/licenses/MIT) [](https://makeapullrequest.com) [](https://qm.qq.com/q/x8kyqzlfDc)

---

CLAUDE.md 是 Claude Code 的项目级配置文件——告诉 AI "在这个项目里该怎么表现"。

一个好的 CLAUDE.md 能让 AI 的代码质量提升 数倍。但大多数人不知道怎么写好它。

本项目收集了 GitHub 上最好的 CLAUDE.md 实践，按语言、框架、场景分类，复制粘贴即可用。

---

# 找到你的项目类型，复制对应的 CLAUDE.md
# 例如：TypeScript + Next.js 全栈项目
cp by-framework/nextjs/CLAUDE.md /your/project/CLAUDE.md

# 根据实际情况修改后即可使用

---

在看模板之前，先理解核心原则：

| 原则 | 说明 | 示例 | |------|------|------| | 具体 | 告诉 AI 具体的规则，而不是模糊的要求 | ✅ "使用 pnpm，不要用 npm" ❌ "用合适的包管理器" | | 简短 | AI 上下文窗口有限，每一行都要有价值 | ✅ 50 行精炼规则 ❌ 500 行长篇大论 | | 可测试 | 规则应该能被客观判断是否遵守 | ✅ "函数不超过 50 行" ❌ "写简洁的代码" | | 项目特定 | 写通用文档不如不写，要写这个项目独有的约定 | ✅ "API 路由放在 src/api/" ❌ "保持代码整洁" |

# ❌ 太模糊
请写高质量的代码，注意性能和可读性。

# ❌ 太长，像教程
## 什么是 React？
React 是一个用于构建用户界面的 JavaScript 库...（省略 200 行）

# ❌ 重复 AI 已知的知识
请使用 ESLint 来检查代码质量。ESLint 是一个...

# ✅ 具体、简短、项目特定
- 包管理器：pnpm（不要用 npm/yarn）
- 测试：vitest，测试文件放在 __tests__/ 下
- API 路由命名：kebab-case，如 /api/user-profile
- 数据库：Prisma ORM，schema 在 prisma/schema.prisma
- 绝不使用 any 类型

# CLAUDE.md

## 项目概述
[一句话描述这个项目是什么]

## 技术栈
- 语言：[语言和版本]
- 框架：[框架和版本]
- 包管理器：[具体工具]
- 数据库：[如有]

## 项目结构
[关键目录说明，只写不明显的]

## 开发规范
[具体的、可测试的规则]

## 构建和测试
[常用命令]

## 注意事项
[这个项目独有的坑和约定]

不知道 CLAUDE.md 里该写什么？试试这个方法：

1. 跑一遍构建：记下每一条命令 → 写入"构建和测试"
2. 看最近 5 次 Code Review 意见：重复出现的问题 → 写入"开发规范"
3. 回忆上次踩的坑：新人最容易犯的错 → 写入"注意事项"
4. **列出"绝不要做的事"*