Claude Code Template

Claude代码项目模板

一个全面的、可重用的配置模板 克劳德代码 包括个人偏好、项目要求、MCP服务器示例和自动化脚本。

快速开始 • 特性 • 文档 • 例子

______________________________________________________________________

特性

📋 个人偏好

自定义Claude与您的沟通和编码方式：

• 沟通方式 -语气、冗长、互动模式
• 代码风格 -语言偏好、格式、模式
• 个人背景 -你的背景、技能、工作环境

🎯 项目要求

规范项目范围内的实践：

• 测试标准 -覆盖要求、测试模式
• 文档 -代码注释、API文档、变更日志
• 安全 -身份验证、确认、安全检查表
• 代码质量 -审查标准、错误处理、日志记录

🔌 MCP服务器示例

常见集成的预配置示例：

• GitHub、PostgreSQL、文件系统访问
• 顺序思维、网络搜索、浏览器自动化
• 松弛、内存等
• 自定义服务器模板

⚙️ 配置模板

即用型配置：

• 项目内存模板（CLAUDE.md）
• 带有挂钩和权限的设置
• 示例技能和钩子
• 路径特定规则

📚 综合文档

各方面指南：

• 快速启动和设置说明
• MCP服务器参考
• 定制指南
• 维护和同步策略

快速开始

1.克隆模板

# Clone this repository for a new project
git clone https://github.com/chrismalone617/claude-code-template my-new-project
cd my-new-project

# Remove git history (optional - if you want a fresh start)
rm -rf .git
git init

2.运行安装脚本

chmod +x setup.sh
./setup.sh

安装脚本将：

• 创建必要的目录
• 复制示例文件
• 指导您完成初始配置
• 帮助设置环境变量

3.为您的项目定制

1. 编辑 .claude/CLAUDE.md -更新项目概述、命令、架构
2. 配置MCP服务器 -编辑 .mcp.json 使用您需要的服务器
3. 设置环境变量 -创建 .env 包含所需机密的文件
4. 自定义规则 -调整 .claude/rules/ 以符合您的偏好
5. 更新项目要求 -修改 .claude/rules/project/ 根据您的标准

4.开始使用Claude代码

claude

Claude现在将使用您的自定义配置！

特性

模块化规则系统

.claude/rules/
  ├── personal/          # Your personal preferences (can be symlinked)
  ├── project/           # Project-specific requirements (shared)
  └── examples/          # Example rules to learn from

灵活的MCP配置

• .mcp.json -活动服务器（版本控制）
• .mcp.example.json -综合示例和文档
• .mcp.local.json -本地覆盖（gitignored）

示例技能

常见任务的预置技能：

• /check-standards -验证代码是否符合项目标准
• 添加您自己的自定义技能

钩子示例

通过挂钩实现自动化：

• 编辑后自动格式化代码
• 自动运行测试
• 自定义验证

跨多个项目使用

选项1：按项目克隆

每个项目都有自己的模板副本，为该项目定制。

# For each new project
git clone https://github.com/chrismalone617/claude-code-template my-project
cd my-project
./setup.sh
# Customize for this project

选项2:Symlink个人规则

在所有项目中共享个人偏好：

# Create a personal rules repo
mkdir -p ~/.claude-personal-rules
# Symlink personal rules in each project
ln -s ~/.claude-personal-rules .claude/rules/personal

选项3：模板存储库

用作GitHub模板存储库：

1. 在GitHub上点击“使用此模板”
2. 克隆您的新存储库
3. 为您的项目定制

目录结构

claude-code-template/
├── .claude/
│   ├── CLAUDE.md                    # Project memory template
│   ├── settings.json                # Shared settings
│   ├── settings.local.json.example  # Personal settings example
│   ├── rules/
│   │   ├── personal/                # Personal preferences
│   │   ├── project/                 # Project requirements
│   │   └── examples/                # Example rules
│   ├── skills/
│   │   └── examples/                # Example skills
│   └── hooks/
│       └── examples/                # Example hooks
├── docs/
│   ├── mcp-servers-guide.md         # MCP reference
│   ├── customization-guide.md       # How to customize
│   └── maintenance-guide.md         # Keeping updated
├── .mcp.json                        # Active MCP servers
├── .mcp.example.json                # MCP examples
├── .gitignore                       # Excludes sensitive files
├── setup.sh                         # Setup automation
├── README.md                        # This file
└── SETUP.md                         # Detailed setup guide

文档

• 设置.md -详细的设置说明
• MCP服务器指南 -完整的MCP参考
• 定制指南 -如何定制一切
• 维护指南 -保持配置更新

环境变量

您需要的常见环境变量：

# GitHub integration
GITHUB_TOKEN=ghp_...

# Database (if using)
DATABASE_URL=postgresql://user:pass@localhost:5432/db

# Web search (if using)
BRAVE_API_KEY=...

# Custom services
API_KEY=...

看 设置.md 以获取完整的环境变量参考。

例子

个人沟通风格

# .claude/rules/personal/communication-style.md
- Keep responses concise and technical
- Use examples for complex concepts
- Always explain the "why" behind decisions
- Ask clarifying questions when requirements are ambiguous

项目测试标准

# .claude/rules/project/testing.md
- Minimum 85% code coverage
- Unit tests for all business logic
- Integration tests for APIs
- E2E tests for critical user flows

路径特定规则

# .claude/rules/examples/frontend-example.md
---
paths:
  - "src/components/**"
  - "src/pages/**"
---
- Use functional components with hooks
- All components must have TypeScript types
- Include accessibility attributes

提示

入门指南

• 从简单开始-最初不要过度配置
• 随着您发现偏好，逐渐添加规则
• 以示例为起点
• 使用简单请求测试配置

最佳实践

• 将个人规则与项目规则分开
• 记录规则存在的原因，而不仅仅是它们是什么
• 定期审查和更新规则
• 与团队共享项目规则
• 将敏感数据保存在环境变量中

常见模式

• Symlink个人规则，确保项目之间的一致性
• 使用 .mcp.local.json 适用于特定于机器的MCP服务器
• 保持 .claude/CLAUDE.md 随着项目的发展而更新
• 对代码库的不同部分使用特定于路径的规则

贡献

发现错误或有建议？请打开问题或提交拉取请求！

贡献想法：

• 不同技术栈的其他示例规则
• 更多示例技能
• 其他钩子示例
• 改进文档
• 安装脚本增强功能

许可证

MIT许可证-请参阅 许可证 文件以获取详细信息。

资源

• Claude代码文档 -官方文件
• 模型上下文协议 -MCP规范
• **** -来源和问题
• MCP服务器 -官方MCP服务器
• 出色的MCP服务器 -社区服务器

更新日志

看 更改日志.md 查看详细的版本历史和发行说明。

版本1.0.0（2024-01-22）

• 初始模板发布，结构完整
• 个人偏好模板（沟通、编码、上下文）
• 项目需求模板（测试、文档、安全、质量）
• MCP服务器示例和全面配置
• 示例规则、技能和钩子
• 带验证的交互式设置脚本
• 综合文件（8325+行）

______________________________________________________________________