如何设计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. 代码修改完成后,主动告知需执行的校验、测试命令
相关推荐
莽夫搞战术2 小时前
【量化实战】单卡3090部署Hy-SimulMT-30B-A3B-Interleave同传大模型
大模型·量化·混元·语音翻译·simulmt·ai同传
mantou1322 小时前
只用 Cloudflare 全家桶,给游戏站做一个 RAG 搜索和问答
人工智能·llm
泯泷3 小时前
大模型会吃掉 Harness 吗?Agent 天空上的“两朵乌云”
人工智能·llm·agent
东姬AI6 小时前
迪士尼联手Adobe自训“片场专用“AI模型:当内容工业按下生产线开关,角色“开口“这道工序还没自动化
大模型·数字人·多模态·ai视频生成·内容生产
泯泷13 小时前
一个小改动,让 Claude 在 SWE-bench 上刷新纪录:工具描述有多重要
llm·agent·claude
泯泷17 小时前
模型越聪明越健忘?“上下文腐烂”背后的 3 个解法
人工智能·llm·agent
吴凡wudianmei18 小时前
RAG 别只会向量检索:玄镜为什么加了「特征加权」
llm·agent
火山引擎开发者社区1 天前
接大模型别再自己配 Key、搭代理了,火山引擎 IGA Pages 一步搞定
llm
承渊政道1 天前
LangChainAI应用开发框架【LangChain与LangGraph介绍】
langchain·大模型·langgraph·ai应用开发
Flynn Liang1 天前
LangChain4j 1.23 架构全景:Java 大模型应用的 6 层抽象
java·langchain·大模型·rag·ai agent·langchain4j