rjl
7d49143ae0
- 新增 uuid.ts 工具函数，提供原生和兼容性 UUID 生成方案 - 更新模板详情页面，使用 generateUUID() 替代 crypto.randomUUID() - 模板列表新增页码字段显示 - 优化模板列表组件代码格式，改进可读性 - 更新 Git 提交消息规范文档，强制使用中文描述和具体要求
3.0 KiB
3.0 KiB
inclusion
| inclusion |
|---|
| auto |
Git 提交消息规范
重要：所有提交消息必须使用中文！
本项目严格遵循 Conventional Commits 规范。
提交消息格式
<type>(<scope>): <subject>
<body>
<footer>
必需部分
Type (类型)
提交的类型必须是以下之一：
- feat: 新功能 (feature)
- fix: 修复 bug
- docs: 仅文档更改
- style: 不影响代码含义的更改（空格、格式化、缺少分号等）
- refactor: 既不修复 bug 也不添加功能的代码更改
- perf: 提高性能的代码更改
- test: 添加缺失的测试或更正现有测试
- build: 影响构建系统或外部依赖的更改（示例范围：webpack, npm, vite）
- ci: 对 CI 配置文件和脚本的更改（示例范围：GitHub Actions, GitLab CI）
- chore: 其他不修改 src 或测试文件的更改
- revert: 回退之前的提交
Subject (主题)
- 必须使用中文描述
- 使用简洁的语言描述本次提交的更改
- 不超过 50 个字符
- 首字母小写
- 结尾不加句号
可选部分
Scope (范围)
用于说明提交影响的范围，例如：
- component: 组件相关
- api: API 相关
- router: 路由相关
- store: 状态管理相关
- utils: 工具函数相关
- styles: 样式相关
- deps: 依赖项相关
Body (正文)
- 详细描述本次提交的动机和更改内容
- 可以分多行
- 应该说明"是什么"和"为什么"，而不是"怎么做"
Footer (页脚)
- 用于关闭 Issue 或描述破坏性变更
- Breaking Changes 必须在页脚中以
BREAKING CHANGE:开头 - 关闭 Issue 使用
Closes #issue号
示例（必须使用中文）
简单的功能添加
feat(article): 添加文章搜索功能
修复 bug
fix(login): 修复登录状态未持久化的问题
包含详细描述
feat(editor): 支持 markdown 实时预览
添加了一个新的编辑器组件，支持 markdown 的实时预览功能。
用户在编辑时可以同时看到渲染后的效果，提升编辑体验。
Closes #123
破坏性变更
feat(api): 重构用户认证 api
BREAKING CHANGE: 用户认证接口从 /api/auth 迁移到 /api/v2/auth，
旧接口将在下一个版本中移除。客户端需要更新 API 端点。
重要规则
- 严格遵循格式:
<type>(<scope>): <subject> - type 必须小写: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
- subject 必须使用中文: 不要使用英文描述
- subject 首字母小写: 不要大写开头
- subject 不加句号: 结尾不要加标点符号
- 不超过 50 字符: subject 部分要简洁
- 破坏性变更: 必须在 body 中以
BREAKING CHANGE:开头说明
生成提交消息时的要求
- 始终使用中文
- 动词开头（如：添加、修复、更新、优化、重构）
- 描述要具体，避免模糊的表述
- 如果有多个更改，选择最主要的作为 subject