提交规范指南
为了保持项目的提交历史整洁、可读并便于自动化生成更新日志，本项目采用 Commitlint 与 Husky 强制执行提交信息规范。
提交格式
每条提交信息必须包含一个 类型 (Type)，建议在前面添加对应的 Emoji 以增强视觉可读性。
格式如下： Emoji 类型: 描述信息
支持的类型
| Emoji | 类型 | 描述 |
|---|---|---|
| ✨ | feat | 新增功能 (Feature) |
| 🐞 | fix | 修复 Bug |
| 📃 | docs | 仅文档变更 (Documentation) |
| 🌈 | style | 代码格式调整 (空格、缩进、逗号等，不改变逻辑) |
| 🦄 | refactor | 代码重构 (既不是新增功能也不是修复 Bug) |
| 🎈 | perf | 性能优化，提升体验 (Performance) |
| 🔧 | build | 构建流程或外部依赖变更 (如修改 Webpack 配置、升级 npm 包) |
| 🐳 | chore | 对构建过程或辅助工具和库的更改 (不影响源文件、测试用例) |
| ⏳ | workflow | 工作流程改进 |
| ⏪ | revert | 回滚之前的提交 |
示例
bash
git commit -m "✨ feat: 增加验证码登录功能"
git commit -m "🐞 fix: 修复菜单无法嵌套的 bug"
git commit -m "📃 docs: 更新安装指南图片"
git commit -m "🌈 style: 统一 Prettier 格式化"bash
git commit -m "随便写点什么"
git commit -m "修正了一些问题"
git commit -m "完成任务"强制校验机制
本项目已配置以下 Git 钩子：
- pre-commit: 在提交前自动运行
Prettier格式化您的代码。 - commit-msg: 自动校验提交信息的格式。如果格式不正确，提交将被终止。
TIP
坚持使用规范的提交信息，有助于您在未来轻松追溯代码变更，同时也让您的项目看起来更加专业！