Files

2.4 KiB

CLAUDE.md

Claude Code 的仓库级上下文。进入本仓库后,先读本文,再读 docs/00-ai-start-here.md。

仓库用途

本仓库用于实现 Dingding HRM:一个用 Go + Gin 编写的钉钉部门和人员浏览、搜索、同步管理工具。

项目不使用前端框架。Gin 后端既提供 REST API,也托管原生前端静态文件。

Harness Coding 文档入口

本项目后续 Claude Code 编程所需的 harness coding 文档都在 docs/ 目录中。不要依赖根目录 README.md 或历史分析文件作为入口。

文档 用途
docs/00-ai-start-here.md AI coding agent 的启动入口、阅读顺序、任务领取规则
docs/01-vision.md 项目目标、用户、产品原则、非目标
docs/02-requirements.md MVP 需求、用户故事、验收标准
docs/03-tech-stack.md Go + Gin、SQLite、原生前端等技术选型
docs/04-architecture.md 系统结构、职责边界、数据模型、开发顺序
docs/05-coding-rules.md 写代码前必须遵守的硬规则
docs/06-tasks.md 分阶段任务看板,每轮只领取一个任务
docs/api.md REST API 合约、错误格式、分页筛选约定
docs/routes.md 原生前端页面路由和模块归属
docs/current-state.md 当前代码现实、可运行命令、下一步任务

关键事实

  • 新项目技术事实以 docs/03-tech-stack.md 为准。
  • 新项目架构、数据库和目录边界以 docs/04-architecture.md 为准。
  • API 合约以 docs/api.md 为准。
  • 页面与静态前端结构以 docs/routes.md 为准。

工作方式

  1. 先确认当前任务是写文档、初始化代码、实现接口、实现页面,还是做同步逻辑。
  2. 写代码前按 docs/00-ai-start-here.md 的顺序读取上下文。
  3. 从 docs/06-tasks.md 领取一个任务,不跳步。
  4. 修改后运行对应验证命令,并在回复中说明结果。
  5. 如果发现文档和代码现实冲突,优先更新 docs/current-state.md 并说明冲突。

不要做

  • 不要使用 Vue、React、Element Plus 或 Vite。
  • 不要让浏览器直接访问钉钉 OpenAPI。
  • 不要把真实 app_key、app_secret、access_token、手机号写入仓库。
  • 不要从旧 JSON 文件中推断未记录的字段含义。
  • 不要一次性生成完整大系统;按任务看板小步实现。