提交规范

  • 提交规范

    如果你每次在 git commit 时,习惯性的忽略或者随意输入一串字符,例如:123,当下就会产生三个后果:
    A、一天后,你领导不知道你昨天做了啥事儿。
    B、一周后,你都不知道你自己当时做了啥事儿。
    C、代码 review,你被当做了反面教材,罚款买零食。

    规范我们的 git commit 操作,会给后续的代码梳理,问题定位,日志检索带来好处。
    我们要做到,git commit -m '这里别偷懒,清晰准确的描述你本次提交的内容或解决了什么问题'
    当在习惯没有行成的时候,小组负责人要抽空抽检成员的提交质量。

    提交规范有自动化检测的工具,但它只能做到你有没有填写,而不能做到质量检查,所以,还是需要研发人员的自我修养。

    下面是一些不好的案例:
    git commit -m '123' PS:123 是啥意思
    git commit -m 'commit' PS:废话
    git commit -m '优化' PS:优化了啥
    git commit -m '提交' PS:废话
    git commit -m '修改了一个bug' PS:什么BUG
    git commit -m 'goods order' PS:请尽量使用中文来描述

    现实中还会有更多随心所欲的 commit,随着时间推移,若大家都不认真写备注,我们的历史将会是一片混乱。

作者:Wolf  创建时间:2022-11-19 11:35
最后编辑:Wolf  更新时间:2023-11-27 23:47