阅界食谱今天吃什么,先来这里看看
代码片段

Git 提交信息规范

统一格式的提交信息,让历史可读、可检索。

模板正文

格式:<type>(<scope>): <subject>

type 取值:
  feat      新功能
  fix       修 bug
  docs      只改文档
  style     不影响逻辑的格式调整
  refactor  重构(不改行为)
  perf      性能优化
  test      测试
  chore     构建/依赖/杂项

示例:
  feat(auth): 支持手机号验证码登录
  fix(cart): 修复满减金额计算错误
  docs(readme): 补充本地启动步骤

规则:
· 一行不超过 50 字,结尾不加句号
· 正文写「为什么改」,不是「改了什么」(diff 已经说明改了什么)

怎么用

团队协作项目建议直接写进 CONTRIBUTING.md。

使用要点

  • 用 feat/fix 开头,出问题时可搜可筛,回滚也更放心。
  • 一个提交只做一件事,方便出问题时精准回退。

同类模板

Git 提交信息规范 · 阅界食谱