wangyizhe/his
1
3
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
Files
f2c71b08bb1b1a58b4bc9978a1bc43c0fdded7ec
his/docs/specs/commit-template.md
zhugeliang d52bbda8c3 docs: 完善三份构建门禁文档 - 补充前后端协同检查、Java后端门禁、数据库变更字段 
架构评审改进项：
- frontend-checklist.md: 增加后端Maven编译、数据库脚本、接口兼容性检查
- cicd-gatekeeper.md: 补充Java后端构建配置(SpotBugs)、分阶段覆盖率目标
- commit-template.md: 增加数据库变更影响评估字段、精简截图要求
2026-04-24 18:03:45 +08:00

3.8 KiB
Raw Blame History

代码提交变更说明模板

📝 PR/Commit 模板

标题格式

<类型>(<模块>): <简短描述>

示例：
feat(patient): 添加患者基本信息编辑功能
fix(doctor): 修复医生排班显示异常问题
docs(api): 更新预约挂号接口文档
refactor(nurse): 重构护士站护理记录组件

正文模板

## 🔍 变更背景
- **问题描述**：详细说明要解决的问题或实现的需求
- **影响范围**：列出受影响的模块、页面、功能
- **相关链接**：禅道任务ID、需求文档链接等

## 🛠️ 变更内容
- **主要修改**：核心代码变更点
- **技术方案**：采用的技术方案和设计思路
- **兼容性**：是否涉及API或数据结构变更


## 🗄️ 数据库变更
- **表结构变更**：列出新增/修改的表和字段
- **数据迁移**：是否需要数据迁移脚本
- **回滚方案**：数据库变更的回滚策略

## ✅ 验证情况
- **测试覆盖**：单元测试、集成测试覆盖情况
- **手动验证**：手动测试的场景和结果
- **构建验证**：本地构建截图（必填）

## 📋 检查清单
- [ ] 代码已通过 ESLint 检查
- [ ] 本地构建成功（附截图）
- [ ] 核心功能已测试验证
- [ ] 文档已同步更新
- [ ] Code Review 已完成

## 👥 相关人员
- **开发者**：@开发者姓名
- **测试者**：@测试者姓名  
- **审核人**：@架构师姓名

🏷️ 提交类型说明

类型 说明 示例
feat 新功能 feat: 添加用户登录功能
fix Bug修复 fix: 修复表单验证错误
docs 文档更新 docs: 更新API文档
style 代码格式调整 style: 格式化代码
refactor 代码重构 refactor: 重构组件结构
test 测试相关 test: 添加单元测试
chore 构建/依赖等 chore: 升级依赖版本
perf 性能优化 perf: 优化列表加载速度

📁 模块命名规范

模块 说明
patient 患者管理相关
doctor 医生工作站相关
nurse 护士站相关
admin 后台管理相关
common 公共组件/工具
api API接口相关
auth 认证授权相关
payment 支付相关

🖼️ 构建验证截图要求

必须包含的信息

  1. 终端窗口：显示 npm run build 命令执行过程
  2. 成功标识：明确显示构建成功的提示信息
  3. 时间戳：截图包含当前时间，证明是最新构建
  4. 分支信息：显示当前工作分支名称

截图示例

$ git checkout feature/patient-edit
$ npm run build

> his-system@1.0.0 build
> vue-cli-service build

⠇  Building for production...

 DONE  Build complete. The dist directory is ready to be deployed.
 INFO  Check out deployment instructions at https://cli.vuejs.org/guide/deployment.html
                                  
✨  Done in 45.23s.

⚠️ 禁止行为

严重违规（直接拒绝合并）

  • 无构建验证截图
  • 代码存在 ESLint 错误
  • 未填写变更说明
  • 修改无关代码文件

轻微违规（要求修正后重新提交）

  • 描述过于简单
  • 测试覆盖不完整
  • 文档更新滞后
  • 格式不符合规范

💡 最佳实践

高质量提交特征

  • 原子性：每次提交只解决一个问题
  • 可追溯：关联具体的需求或Bug ID
  • 可验证：提供完整的验证证据
  • 可理解：描述清晰，他人能快速理解

团队协作建议

  • 提交前先在本地完整测试
  • 复杂变更提前与团队沟通
  • 及时更新相关文档
  • 主动帮助新人熟悉规范

文档版本：v1.0
最后更新：2026年4月24日
负责人：陈琳（文档专家）
适用范围：HIS 系统所有开发人员