# claude-code-config

**Repository Path**: chencq/claude-code-config

## Basic Information

- **Project Name**: claude-code-config
- **Description**: claude-code-config
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-28
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Claude Code Java 通用配置（可扫描、自适配）

面向 **Java / JVM 项目** 的 [Claude Code](https://docs.anthropic.com/claude/docs) 工作流与规则集：全局说明、路径规则、技能、slash 命令与可选钩子。默认先做 **项目扫描**，再根据仓库事实生成 `project_profile.md` 与适配步骤，而不是预先写死单一技术栈。

若 `~/.claude` 已存在，克隆或拷贝前请先备份。

**快速上手**：普通开发者可先看 **[QUICKSTART.md](./QUICKSTART.md)**。  
**团队落地**：参考 **[TEAM_SOP.md](./TEAM_SOP.md)**。  
**老项目知识梳理**：参考 **[LEGACY_KNOWLEDGE_GUIDE.md](./LEGACY_KNOWLEDGE_GUIDE.md)** 和 **[OLD_PROJECT_GUIDE.md](./OLD_PROJECT_GUIDE.md)**。  
**命令顺序与流程图**：参考 **[COMMAND_FLOW_GUIDE.md](./COMMAND_FLOW_GUIDE.md)**。  
**命令使用说明**：参考 **[COMMAND_REFERENCE.md](./COMMAND_REFERENCE.md)**。  
**详细流程、能力缺口说明与排障**：见 **[实战操作手册.md](./实战操作手册.md)**；Hook 配置示例见 [examples/settings.hooks.example.json](./examples/settings.hooks.example.json)。

## 安装

### 方式一：Git 克隆到 `~/.claude`

```bash
git clone <本仓库 URL> ~/.claude
```

### 方式二：在 Claude Code 中粘贴安装提示词

复制 `INSTALL.md` 中的提示块，粘贴到 Claude Code，由其拉取并写入对应路径（请把其中的仓库地址换成你的实际地址）。

### 方式三：按需拷贝

```bash
git clone <本仓库 URL> /tmp/claude-java-config
cp -r /tmp/claude-java-config/rules/* ~/.claude/rules/
cp -r /tmp/claude-java-config/skills/* ~/.claude/skills/
cp -r /tmp/claude-java-config/agents/* ~/.claude/agents/
cp -r /tmp/claude-java-config/commands/* ~/.claude/commands/
cp -r /tmp/claude-java-config/hooks/* ~/.claude/hooks/
# 若 ~/.claude/CLAUDE.md 已存在，请手动合并而非覆盖
cp /tmp/claude-java-config/CLAUDE.md ~/.claude/CLAUDE.md
```

安装后为新会话或重启 Claude Code。钩子脚本需可执行：

```bash
chmod +x ~/.claude/hooks/*.py ~/.claude/hooks/*.sh 2>/dev/null || true
```

在 `~/.claude/settings.json` 中按需注册钩子（字段名以你使用的 Claude Code 版本文档为准），例如将 `UserPromptSubmit` 指向 `keyword-detector.py`，将 `PostToolUse`（限 Write/Edit）同时指向 `check-comments.py` 与 `suggest-verify.py`，将 `Stop` 指向 `todo-enforcer.sh`。**todo-enforcer** 依赖系统已安装 `jq`。

## 内容说明

| 目录 / 文件 | 说明 |
|-------------|------|
| `CLAUDE.md` | 全局工作流与“项目画像优先”的 Java 约定 |
| `rules/java.md` | `*.java` 通用工程约定；具体框架与版本以项目扫描结果为准 |
| `rules/java-testing.md` | Java 测试策略；JUnit / Mockito / Spring Test 风格以仓库事实为准 |
| `rules/comments.md` | 注释策略 |
| `skills/java-build-verify` | Maven / Gradle 的编译、测试与代码生成验证建议 |
| `skills/planning-with-files` | 多步骤任务用 Markdown 持久化规划 |
| `skills/spec-driven-change` | `openspec/changes/` 规范驱动变更说明 |
| `agents/` | 代码库搜索、外部资料检索、技术文档等子代理 |
| `commands/*.md` | slash 命令（项目扫描、项目适配、架构梳理、流程梳理、安全重构、阻塞项修复、文档修复、变更验证、风险初筛、澄清、规格、审查、排障、合入、文档、复盘等） |
| `hooks/` | 关键词模式、注释比例提示、改后验证建议、轻量风险扫描脚本、未完成 Todo 时阻止结束 |
| `examples/` | Hook、settings 示例与 todo-enforcer 配置样板 |
| `实战操作手册.md` | 结构说明、不完善项、按场景步骤与排障 |