项目开发约定
概述
此技能定义了本项目的开发模式和约定。
技术栈
- 主要语言: Java (JDK 25+)
- 架构: Spring Boot + MyBatis
- 测试位置:
src/test/java
提交约定
遵循约定式提交格式:
使用的前缀
feat - 新功能
fix - 错误修复
docs - 文档变更
test - 测试添加或更新
refactor - 代码重构
style - 代码风格变更(格式化、分号等)
chore - 构建过程或辅助工具变更
消息规范
- 保持第一行简洁且有描述性(少于 70 个字符)
- 使用祈使语气("添加功能"而非"添加了功能")
- 相关时包含范围:
feat(范围): 描述
代码风格
- 遵循 Java 命名约定
- 使用有意义的变量和方法名
- 为公共 API 添加 Javadoc
- 保持方法专注且单一职责
测试
- 为业务逻辑编写单元测试
- 为数据库操作使用集成测试
- 保持测试覆盖率在 80% 以上
合并请求规范
- 保持合并请求专注且小
- 为新功能包含测试
- 根据需要更新文档
- 合并前审查代码