docs: add AGENTS.md development guidelines
This commit is contained in:
39
AGENTS.md
Normal file
39
AGENTS.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# 医签通项目开发规范
|
||||
|
||||
本文件适用于 `medical-sign` 仓库及其子目录。子目录中的 `AGENTS.md` 可以补充更具体的应用规范。
|
||||
|
||||
## 项目结构
|
||||
|
||||
- `clinical-web`:医护端、电子病历嵌入端和管理端,电脑端优先。
|
||||
- `patient-h5`:患者或家属使用的手机签署 H5,不是移动版电子病历。
|
||||
- `packages`:两个应用稳定共用的接口客户端、类型和基础逻辑;不单独部署。
|
||||
- 两个应用分别维护自己的 `package.json`、`node_modules` 和构建产物。
|
||||
|
||||
## 通用原则
|
||||
|
||||
- 以“患者 + 就诊 + 医嘱/项目 + 签署任务 + 文书版本 + 签署证据”为核心业务关系。
|
||||
- 解释医生、实际签署人和协助操作人员必须分别建模和记录。
|
||||
- 已签署的正式文书不可直接修改;追加内容应创建新的签署任务。
|
||||
- 前端不替代后端完成权限、身份和签署有效性校验。
|
||||
- 不在代码、日志或提交中写入 Token、密码、身份证号、完整病历等敏感信息。
|
||||
- 不把 `dist`、`node_modules`、本地 `.env` 和临时文件提交到仓库。
|
||||
- 未经明确要求,不执行 `git commit`、`git push` 或覆盖他人已有修改。
|
||||
|
||||
## 共享代码
|
||||
|
||||
- 只有在两个应用确实复用且接口已经稳定时,才将代码放入 `packages`。
|
||||
- 应用内只通过明确的公共导出使用共享包,不直接依赖共享包的内部文件。
|
||||
- 与单个应用强相关的页面、组件、Store 和接口,保留在对应应用中。
|
||||
|
||||
## 开发与验证
|
||||
|
||||
在对应应用目录执行其自己的脚本:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
npm run lint
|
||||
npm run format:check
|
||||
npm run build
|
||||
```
|
||||
|
||||
修改接口、状态或跨页面组件时,应同时更新相应的 TypeScript 类型和 README/开发说明。
|
||||
Reference in New Issue
Block a user