如何设计CLAUDE.md

项目概述

本项目为 AI 智能体全栈项目。

后端基于 Python、FastAPI、LangChain、LangGraph 构建智能 Agent 服务;前端使用 Vue3 开发。

技术栈:Python3.12+、Pydantic、mypy、ruff、pytest、FastAPI、LangChain、LangGraph、Vue3、Pinia。

所有代码修改、新增逻辑必须严格遵循本文档命令、代码规范与开发流程。

目录规范

  • src/langchain/:LangChain、LangGraph 核心业务逻辑
  • prompts/:所有提示词模板,禁止业务代码内硬编码长提示词
  • src/utils/:通用工具函数,新增函数必须配套单元测试
  • tests/:单元测试目录,tests/graph/ 专门存放 LangGraph 测试用例
  • src/router/:FastAPI 路由定义
  • src/service/:业务逻辑层
  • src/schema/:Pydantic 数据模型

常用命令

  • npm run dev:启动 Vue3 前端开发服务
  • uvicorn main:app --reload:启动 FastAPI 后端热更新服务
  • pytest tests/:执行全部后端单元测试
  • pytest tests/graph/:仅运行 LangGraph 智能体模块测试
  • docker-compose up -d:后台启动向量库、Redis 等依赖服务
  • git pull && git checkout -b feature/xxx:拉取最新代码并新建功能分支

代码规范

  • Python:统一使用 Python3.12+,开启 mypy 严格类型校验,数据模型全部使用 Pydantic 定义
  • LangGraph:严格拆分状态、节点、边逻辑;节点优先纯函数写法,禁止使用全局变量存储会话状态,所有会话数据统一托管在 Graph State
  • LangChain:所有封装逻辑统一放在 src/langchain/,提示词全部抽离至 prompts/ 目录
  • FastAPI:严格遵循路由、业务、模型分层架构,工具函数统一归入 src/utils/
  • Vue3:统一使用 <script setup> 语法,全局状态优先使用 Pinia 管理
  • Git 提交:采用 feat/fix/refactor/docs 规范前缀,禁止一次性大批量提交代码

开发工作流

  • Python 代码修改完成后,执行静态类型检查:mypy src/
  • 前端代码修改完成后,执行类型校验:npm run type-check
  • 代码提交前统一格式化纠错:后端 ruff check --fix .、前端 npm run format
  • 本地运行对应模块 pytest 测试,新增逻辑必须补充对应测试用例
  • 提交 PR 时,附带改动说明、接口出入参示例、关键业务截图
  • PR 合并前,确保 CI 流水线(类型检查、代码规范、单元测试)全部通过

AI 强制约束

  1. 新增业务逻辑时,同步设计并编写 pytest 单元测试
  2. 修改 LangGraph 逻辑优先更新 State 定义,不允许只改节点不更新状态
  3. 禁止私自引入第三方依赖,如需新增库必须先说明用途
  4. 代码修改完成后,主动告知需执行的校验、测试命令
相关推荐
dozenyaoyida2 小时前
AI与大模型新闻日报 | 2026-09-30
大数据·人工智能·大模型·新闻
小范的技术工坊3 小时前
大模型结构化输出
大模型·结构化
张晓宇 .4 小时前
Codex 使用教程(2026年9月 0.158 最新版):安装、国内接入 DeepSeek / GPT-6、config.toml 配置与报错排查
gpt·大模型·openai·ai编程·codex·deepseek
小马9267 小时前
KV Cache 瘦身 437 倍:DeepSeek V4.1-Flash 的推理效率革命
大模型·moe·kv cache·deepseek·推理优化·ai基础设施
fundroid9 小时前
Android AI 开发,真正拉开差距的是工程闭环
android·ai·大模型·agent
吃饱了得干活9 小时前
Agent 的核心组件:大脑、记忆、手脚与心跳
llm·agent
AI视觉网奇9 小时前
本地部署 Qwen-Image 文生图:完整流程与避坑指南
大模型
梦想不只是梦与想10 小时前
LangGraph的运行时:编译、执行与持久化(三)
大模型·langgraph·checkpointer
leoZ23110 小时前
第 40 篇 AI 团队搭建与角色分工
人工智能·大模型·agent
Alice-YUE10 小时前
A2A 协议详解:Agent 间通信标准、四大核心机制与 MCP 互补
大模型·多智能体·ai agent·mcp·a2a协议