规范的 commit (Angular规范)

1. commit message

  • commit message 分3个部分:head, body, footer

    • head: <type> (scop): subject
      • type: feat, fix, docs, style, refactor, test, chore, revert, perf, build
      • score: 影响范围
      • subject: 简短描述(动词开头,首字母小写,结尾不加.)
    • body: 详细描述
    • footer: (1) 不兼容改动;(2) 关闭issue
  • revert 有特殊的格式

    # head: revert: <要被撤销的commit的head>
    # body: This reverts commit <commit-hash>.
    # eg:
    	revert: docs add README.md
    	This reverts commit a2d04c0b914785e4ff0cdf4baeea84d8611c7a61.
    

2. 一些规范commit message的工具

  • commitizen:辅助编写规范的commit message

    # 安装commitizen
    cnpm install -g --save-dev commitizen
    # 生成package.json文件
    npm init --yes
    # 设置支持commit message格式
    commitizen init cz-conventional-changelog --save --save-exact
    

    使用git cz代替git commit

  • 0
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Git Commit规范是一种约定俗成的方式,用于规范化提交信息的格式和内容,使得提交历史更加清晰、易读和易于管理。以下是一种常见的Git Commit规范: 1. 提交信息的结构:每个提交信息由三个部分组成:标题、正文和页脚。 标题:简明扼要地描述这次提交的内容,通常以动词开头,使用一般现在时,不超过50个字符。 正文:对提交的详细描述,可以包括为什么进行该提交、做了哪些修改等信息。 页脚:可包含与提交相关的其他附加信息,如关联的Issue编号、作者等。 2. 提交信息的格式:为了保持统一和易读性,可以采用以下格式: ``` <type>(<scope>): <subject> <body> <footer> ``` 其中,`<type>`代表提交的类型,如`feat`(新功能)、`fix`(修复bug)、`docs`(文档更新)等。 `<scope>`代表本次提交的范围,可以是具体的文件、模块或功能名称。 `<subject>`是对本次提交内容的简要描述。 `<body>`是对本次提交内容的详细描述。 `<footer>`是页脚部分,可以包含相关链接、引用等信息。 3. 示例: ``` feat(user): 添加用户注册功能 - 在用户界面增加注册表单 - 后端增加注册接口 Issue #123 ``` 通过遵循Git Commit规范,可以提高团队协作效率、减少沟通成本,并且更好地追踪和管理项目的提交历史。当然,具体的规范可以根据团队的实际需求和偏好进行调整和定制。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值