2.3 KiB
2.3 KiB
AGENTS.md
本文件用于约束后续在本项目内协作的 AI/自动化代理行为。
项目目标
这是一个面向新手的微信小程序项目,目标是:
- 保持项目结构简单、易懂、易修改
- 使用
Taro + React + TypeScript作为核心技术栈 - 所有说明尽量使用中文
- 在保证可运行的前提下,减少复杂依赖
协作原则
- 修改代码前,先阅读现有文件,避免无意义重构。
- 优先做小步修改,保持项目始终可运行。
- 已确认使用
React + TypeScript,默认采用Taro作为微信小程序框架。 - 不要在
Taro之外再擅自引入新的大型框架或状态管理库,除非用户明确要求。 - 对新手不友好的实现方式,要同时补充解释性注释或文档。
- 涉及配置时,优先使用明确值,并在文档里写清楚用户需要修改的位置。
文件与代码规范
- 默认使用 UTF-8 编码。
- 页面、组件和配置命名尽量贴合
Taro与微信小程序习惯。 - 目录结构优先采用:
src/pages/放页面src/components/放可复用组件src/utils/放工具函数src/assets/放静态资源config/放 Taro 构建配置
- 默认使用 TypeScript 编写业务代码。
- 样式优先使用
.scss,但保持简单,避免过度抽象。 - 非必要不新增依赖,尤其避免在项目初期引入复杂状态管理、UI 大全家桶或重型工具链。
修改边界
- 可以新增或修改当前工作区内与本项目直接相关的文件。
- 如需删除文件,必须严格遵守工作区已有的删除安全规则。
- 不得擅自删除目录、批量删除文件、清空文件夹。
- 不得覆盖用户未明确要求替换的重要配置、密钥或证书文件。
AppID 与发布相关
- 不要伪造真实
AppID、密钥、证书、域名或后台接口地址。 - 涉及
AppID时,优先保留用户提供的真实值。 - 如果项目需要上线步骤说明,必须同步更新
README.md。
文档要求
- 每次新增关键功能、配置步骤或部署步骤时,优先同步更新
README.md。 - 文档写法以“零基础可照做”为标准,避免只写结论不写路径。
- 如果修改了 Taro 的开发、编译、预览或发布流程,必须更新
README.md中对应命令和目录说明。