前端📖人 的 commit 规范

159 阅读2分钟

2023 年了,还有前端人不知道 commit 规范 ?

你可能会觉得,commit 规范是什么鬼?我只要把代码提交上去就行了,管它叫什么名字?🤷‍♂️

但是,你有没有遇到过这样的情况:

  • 你想回滚到某个版本,但是你的 commit 信息都是“update”、“fix bug”、“change something”这样的,你根本不知道哪个是你想要的。😭
  • 你想查看某个功能是谁写的,但是你的 commit 信息都是“add feature”、“update feature”、“delete feature”这样的,你根本不知道哪个是你想要的。😡
  • 你想生成一个版本日志,但是你的 commit 信息都是“update”、“fix bug”、“change something”这样的,你根本不知道怎么写。😵

如果你有过这样的经历,那么恭喜你,你需要学习一下 commit 规范。👏

commit 规范,顾名思义,就是规定了每次提交代码时,应该如何写 commit 信息的一套规则。它可以帮助你:

  • 提高代码可读性和可维护性。📚
  • 方便代码回溯和追踪。🕵️‍♂️
  • 自动生成版本日志和变更记录。📝
  • 协作开发时,保持团队风格一致。👥

那么,如何写一个规范的 commit 信息呢?其实很简单,只要遵循以下几个原则:

  • 使用一定的格式:<type>(<scope>): <subject>。其中,type表示提交类型,scope表示影响范围(可选),subject表示简短描述。
  • 使用固定的类型:比如feat表示新功能,fix表示修复问题,docs表示文档更新等等。具体可以参考这里
  • 使用现在时态:比如add而不是addedchange而不是changed
  • 首字母不要大写:比如fix bug而不是Fix bug
  • 结尾不要加句号:比如change style而不是change style.

举个例子,如果你添加了一个登录功能,那么你可以这样写 commit 信息:

feat(login): add login feature  

如果你修复了一个导航栏的样式问题,那么你可以这样写 commit 信息:

fix(nav): change nav style  

如果你更新了 README 文件,那么你可以这样写 commit 信息:

docs: update README  

看起来是不是很清晰明了?😎

当然,这只是一个简单的介绍,commit 规范还有很多高级用法,比如添加正文、脚注、关联 issue 等等。如果你想深入学习,可以参考这篇文章

总之,commit 规范是一个非常有用的工具,它可以让你的代码更加优雅和专业。2023 年了,还有前端人不知道 commit 规范吗?快来学习吧!😉