24 lines
1.5 KiB
Markdown
24 lines
1.5 KiB
Markdown
# CLAUDE.md
|
||
|
||
本文件为 Claude Code 在本工程中工作时的约定与规范。
|
||
|
||
## 项目简介
|
||
|
||
Spellforge（万法熔炉）—— Godot 4.6 (Mono) 弹幕射击 Roguelite，SoA / ECS-Lite 架构，法术管道系统。工程概览见 [`README.md`](README.md)。
|
||
|
||
## Git 提交规范
|
||
|
||
- **及时提交**：完成一个逻辑完整的改动（一个功能点、一处修复、一批相关文档更新）后应立即提交，不要将多个无关改动堆积在一个大提交里。
|
||
- 提交信息使用中文，简明说明「做了什么、为什么」。
|
||
- 仅在用户要求时才 push；如当前在主分支（`main` / `master`）上进行功能开发，先切分支。
|
||
- 提交前确认改动范围符合预期（`git status` / `git diff`），不要顺手提交无关文件。
|
||
|
||
## 文档存放规范
|
||
|
||
工程文档分两处存放，新增或修改文档时按用途归位：
|
||
|
||
- **`docs/`** —— **项目指导 / 架构设计等权威文档**。面向产品的设计规范、技术架构、机制细节、开发手册。这是跨切片实现约束的权威来源（含关键规范速查表 `P6-N*` / `ADR-*`）。索引见 [`docs/README.md`](docs/README.md)。
|
||
- **`docs_dev/`** —— **开发过程中产生的文档**。开发计划、进度追踪、审计报告、平台认证清单、历史归档草案等过程性文档。索引见 [`docs_dev/README.md`](docs_dev/README.md)。
|
||
|
||
> 判断依据：若文档是「项目应当如何设计/实现」的权威规范 → `docs/`；若是「开发过程中的计划、记录、追踪、归档」→ `docs_dev/`。
|