docs: 添加仓库协作指南文档
添加 AGENTS.md 文档,详细说明项目技术栈、常用命令、目录结构约定、编码规范以及提交前检查事项,为项目协作提供统一指南。
Showing
1 changed file
with
26 additions
and
0 deletions
AGENTS.md
0 → 100644
| 1 | +# 仓库协作指南 | ||
| 2 | + | ||
| 3 | +## 项目概览 | ||
| 4 | +这是一个基于 `Vue 2.7`、`Vite 5`、`Vue Router 3` 和 `Element UI 2` 的官网型前端项目,面向海格电器站点。运行环境要求 `Node 18.13.x`,默认使用 `npm` 脚本。页面主体集中在 `src/views`,通用组件在 `src/components`,接口封装在 `src/api`,路由入口是 `src/router.js` 与 `src/route.js`。 | ||
| 5 | + | ||
| 6 | +## 常用命令 | ||
| 7 | +- `npm run dev`:本地开发。 | ||
| 8 | +- `npm run build`:生产构建。 | ||
| 9 | +- `npm run preview`:本地预览构建结果。 | ||
| 10 | +- `npm run build_tar`:构建并打包产物。 | ||
| 11 | +- `npm run dev_upload` / `npm run oa_upload`:上传并解压到内网目标环境。此类命令会直接操作远端目录,修改前先确认部署路径与目标环境。 | ||
| 12 | + | ||
| 13 | +## 目录与改动约定 | ||
| 14 | +- 页面级改动优先落在 `src/views/**`,不要把页面业务堆进全局入口。 | ||
| 15 | +- 可复用展示组件放在 `src/components/**`,公共方法放在 `src/utils/**` 或 `src/common/**`。 | ||
| 16 | +- 接口请求统一收敛到 `src/api/**`,避免在视图组件里直接拼请求逻辑。 | ||
| 17 | +- 样式优先复用现有 `scss`、`less` 变量,不要随意新增一套命名体系。 | ||
| 18 | + | ||
| 19 | +## 编码要求 | ||
| 20 | +- 新增说明性文字、文档、注释默认使用中文;只有接口字段、库 API、品牌专有名词保留原文。 | ||
| 21 | +- 保持现有代码风格,避免无关格式化和大面积重排。 | ||
| 22 | +- 这个仓库存在较多历史代码与手工维护页面,重构前先确认影响范围,尤其是头部、页脚、路由和 SEO 相关逻辑。 | ||
| 23 | +- 如无特殊原因,不要改动上传、打包、压缩脚本中的路径、文件名和解压目录。 | ||
| 24 | + | ||
| 25 | +## 提交前检查 | ||
| 26 | +仓库当前没有成体系的自动化测试脚本。提交前至少执行一次 `npm run build`,并检查受影响页面的路由、接口调用和静态资源引用是否正常。提交信息建议沿用现有风格,例如 `fix(contact): 更新联系我们页面顶部横幅图片`、`docs(页脚): 更新公司地址和名称信息`。 |
-
Please register or login to post a comment