hookehuyr

docs(config): 添加通用编码 Agent 入口指引

为非 Claude Code 的通用编码 Agent 提供项目概览、常用命令、
关键约束和推荐阅读路径的轻量入口文档。

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Showing 1 changed file with 134 additions and 0 deletions
1 +# Agent.md
2 +
3 +本文件为通用编码 Agent 在处理此仓库时提供入口说明。
4 +
5 +原则:保持轻量,只放高频规则和导航信息;详细说明优先查看 [CLAUDE.md](./CLAUDE.md) 与对应子目录文档。
6 +
7 +---
8 +
9 +## 项目概览
10 +
11 +- 项目名称:Manulife WeApp(臻奇智荟圈)
12 +- 技术栈:Taro 4.1.x + Vue 3 + NutUI + Pinia + Less + TailwindCSS
13 +- 代码形态:以 JavaScript / Vue SFC 为主,非 TypeScript 仓库
14 +- 目标平台:微信小程序为主,同时保留 H5 / 支付宝 / 百度 / 字节等平台构建脚本
15 +
16 +---
17 +
18 +## 开始前先做什么
19 +
20 +1. 先读根目录 [CLAUDE.md](./CLAUDE.md) 了解项目级约束。
21 +2. 如果修改范围落在某个目录下,继续读取该目录最近的 `CLAUDE.md`
22 +3. 涉及页面、组件、认证、API 时,优先查看 `docs/` 下对应指南,避免重复踩坑。
23 +
24 +就近规则优先:离目标代码最近的 `CLAUDE.md` 应视为该目录范围内的补充约束。
25 +
26 +---
27 +
28 +## 常用命令
29 +
30 +```bash
31 +pnpm install
32 +pnpm dev:weapp
33 +pnpm dev:h5
34 +pnpm build:weapp
35 +pnpm lint
36 +pnpm test
37 +pnpm api:generate
38 +pnpm parse:docs:status
39 +```
40 +
41 +---
42 +
43 +## 修改代码前必须知道
44 +
45 +### 1. 认证链路不能随意改
46 +
47 +关键文件:
48 +- `src/utils/openid.js`
49 +- `src/utils/request.js`
50 +- `src/pages/login/index.vue`
51 +
52 +项目依赖“静默认证 + 401 自动刷新”维持会话,任何认证相关改动都要先读现有实现。
53 +
54 +### 2. API 成功态统一检查
55 +
56 +所有接口调用都应通过现有 API 包装方式处理,并显式检查:
57 +
58 +```js
59 +res.code === 1
60 +```
61 +
62 +### 3. 样式策略是混合式
63 +
64 +- 布局、间距、排版、颜色优先用 TailwindCSS
65 +- 组件私有样式、深层覆盖、复杂选择器再用 Less
66 +
67 +### 4. 重复逻辑到第 3 次要抽
68 +
69 +仓库约定遵循“第 3 次出现原则”,重复逻辑优先抽为 composable、公共组件或工具函数。
70 +
71 +### 5. 组件对象注意响应式开销
72 +
73 +涉及组件配置对象时,优先使用 `shallowRef` / `markRaw` 规避不必要的深层响应式。
74 +
75 +### 6. 保持注释和文档完整
76 +
77 +仓库已有明确的文档化习惯。新增复杂逻辑时补最小必要注释;若改动影响使用方式,补对应文档。
78 +
79 +---
80 +
81 +## 关键目录
82 +
83 +- `src/pages/`:页面入口
84 +- `src/components/`:通用组件
85 +- `src/composables/`:复用逻辑
86 +- `src/api/`:接口定义与调用包装
87 +- `src/stores/`:状态管理
88 +- `src/utils/`:基础工具、认证、请求封装
89 +- `config/`:功能与权限配置
90 +- `docs/`:项目文档、指南、报告、API 规范
91 +- `scripts/`:脚本工具,包含 API 生成与文档解析
92 +
93 +---
94 +
95 +## 推荐阅读路径
96 +
97 +### 快速熟悉项目
98 +
99 +1. [README.md](./README.md)
100 +2. [CLAUDE.md](./CLAUDE.md)
101 +3. [docs/README.md](./docs/README.md)
102 +
103 +### 涉及具体开发时
104 +
105 +- 页面开发:`docs/guides/page-development.md`
106 +- API 集成:`docs/guides/api-integration.md`
107 +- 导航处理:`docs/guides/navigation.md`
108 +- 调试问题:`docs/debugging.md`
109 +- 最佳实践:`docs/best-practices.md`
110 +
111 +### 涉及历史经验时
112 +
113 +- `docs/lessons-learned/lessons-learned.md`
114 +- `docs/CHANGELOG.md`
115 +
116 +---
117 +
118 +## Agent 工作建议
119 +
120 +- 改动前先确认是否已有同类实现,尽量复用现有模式。
121 +- 修改页面或组件时,检查目标目录下是否已有局部 `CLAUDE.md`
122 +- 涉及认证、请求链路、路由、计划书模块时,先读文档再改代码。
123 +- 提交前至少运行与改动范围匹配的校验,例如 `pnpm lint``pnpm test` 或定向验证。
124 +
125 +---
126 +
127 +## 文档定位
128 +
129 +`Agent.md` 是通用入口。
130 +
131 +- 想快速知道“先看什么”:看本文件
132 +- 想知道完整项目约束:看 [CLAUDE.md](./CLAUDE.md)
133 +- 想知道模块细节:看对应目录下的 `CLAUDE.md`
134 +- 想了解业务与历史背景:看 [docs/README.md](./docs/README.md)