Git语义化提交规范(Conventional Commits)
📚 常见的语义化提交类型包括:
类型 | 含义说明 |
---|---|
feat | ✨ 新增功能(feature) |
fix | 🐛 修复 bug |
docs | 📚 修改文档(如 README) |
style | 💄 格式调整,不影响代码逻辑(如缩进) |
refactor | 🔨 代码重构,非功能性修改 |
test | ✅ 增加或修改测试代码 |
chore | 🔧 构建过程或辅助工具的变动 |
perf | ⚡ 性能优化 |
ci | 🤖 持续集成相关配置或脚本 |
✅ 示例:
git commit -m "feat: 新增用户登录接口"
git commit -m "fix: 修复登录失败后页面未跳转的问题"
Git 提交模板(commit message template)
你可以配置到你的 Git 项目中,帮助你规范化每次提交的说明。
✅ Git 提交模板内容(.gitmessage.txt)
# 请填写有意义的提交说明(英文或中文均可)
# 提交类型请参考下面的说明,在冒号后加空格书写内容# feat: ✨ 新功能(feature)
# fix: 🐛 修复 bug(bug fix)
# docs: 📚 文档变更(仅修改文档,不修改代码)
# style: 💄 代码格式(不影响功能,例如空格、缩进)
# refactor: 🔨 代码重构(既不是新增功能,也不是修 bug)
# perf: ⚡ 性能优化(提高代码运行效率)
# test: ✅ 添加或修改测试代码
# chore: 🔧 构建工具、依赖库、脚本等变更
# ci: 🤖 CI/CD 配置变更# 示例:
# feat: 增加登录功能
# fix: 修复登录失败后页面未跳转的问题<type>: <简短描述># 空一行后可以填写详细描述(可选)
# - 修改动机
# - 实现思路
# - 注意事项# -----------------------
# 注意:提交说明第一行不要超过 100 个字符
🛠 如何使用这个模板?
- 创建模板文件
在项目根目录或任意位置创建一个提交模板文件,例如:
touch ~/.gitmessage.txt
将上面的内容粘贴进去并保存。
2. 设置全局 Git 配置
git config --global commit.template ~/.gitmessage.txt
设置后每次你运行 git commit(不加 -m)时,编辑器会打开这个模板,方便你填写规范的提交说明。
如果你使用 VSCode 或 IDEA 等编辑器:
VSCode 会自动打开 .gitmessage.txt 模板供你填写;
IDEA 也支持你编辑 commit message,可以手动遵守规范