git
› Pro Git
› Atlassian Git Tutorial
› Pro Git 简体中文翻译
› GitX
ljzxloaf
V2EX  ›  git

你们写 commit message 有规范吗?

  •  
  •   ljzxloaf · Nov 24, 2023 · 13029 views
    This topic created in 1085 days ago, the information mentioned may be changed or developed.
    如果有的话,有些怎样的规范?
    Supplement 1  ·  Nov 24, 2023
    大家会在 commit message 里加需求链接或者 bug 链接吗?像 jdk 或者 linuxkernel 那样?
    60 replies  •  2023-11-26 23:53:45 +08:00
    zcf0508
    zcf0508
    Nov 24, 2023 via Android
    1
    cz
    hez2010
    hez2010
    Nov 24, 2023
    2
    wangwenfan
    wangwenfan
    Nov 24, 2023❤️1
    3
    模版大概是在这样的:
    <type>[optional scope]: <description>

    [optional body]
    [optional footer(s)]
    FlashEcho
    FlashEcho
    Nov 24, 2023
    4
    一般会加个开头吧 fix feat perf 之类的,但是这个好像也不是通行标准,有不少大厂的重要开源项目也不这么搞
    Altale
    Altale
    Nov 24, 2023❤️1
    5
    https://gist.github.com/ericavonb/3c79e5035567c8ef3267
    https://www.conventionalcommits.org/en/v1.0.0/#specification
    网上有很多,组里遵循不遵循与我无关,我都按照一定的风格写。
    zjp
    zjp
    Nov 24, 2023 via Android❤️1
    6
    约定式提交规范 https://www.conventionalcommits.org/zh-hans/v1.0.0/
    根据自己项目改改
    hez2010
    hez2010
    Nov 24, 2023
    7
    @chesha1 开头加 fix feat perf 其实主要是为了方便用工具自动生成 release note
    ljzxloaf
    ljzxloaf
    OP
    Nov 24, 2023
    8
    @hez2010 #2 好用吗
    pengtdyd
    pengtdyd
    Nov 24, 2023
    9
    有,用的是 angularjs 的规范。咦,我好像发现 angularjs 本身不怎么样,但是它搞的很多规范很实用。。。。
    AoEiuV020JP
    AoEiuV020JP
    Nov 24, 2023
    10
    没人管,我是尽量确保第一行简洁明了的写出改了什么,第二行空白,第三行看情况补充说明,

    HenryHE
    HenryHE
    Nov 24, 2023
    11
    有规范,毕竟每一个 commit 都是有原因的,所以会加上追踪信息。
    kosilence
    kosilence
    Nov 24, 2023
    12
    [ticket-number][which server] project name: what changed
    KMpAn8Obw1QhPoEP
    KMpAn8Obw1QhPoEP
    Nov 24, 2023 via Android
    13
    conventional commits+husky
    charmToby
    charmToby
    Nov 24, 2023❤️1
    14
    有的,一般会加上任务 ID 或者 bug ID
    dif
    dif
    Nov 24, 2023
    15
    用,和 angular 一样的规范。
    doco
    doco
    Nov 24, 2023❤️1
    16
    update, update xxx, update...
    jonty
    jonty
    Nov 24, 2023
    17
    新增/修复(范围):描述
    iovekkk
    iovekkk
    Nov 24, 2023
    18
    有,要标记一下是 bug 修复还是功能开发
    bug 修复要加上 bugid
    wu67
    wu67
    Nov 24, 2023❤️1
    19
    (fix|update|change|feat|remove): (模块-子模块-页面-组建). 功能描述内容巴拉巴拉. 如果有 issue 就再加上井号+id, 其他非同一平台的不管
    lshang
    lshang
    Nov 24, 2023
    20
    同 6 楼,conventional commit
    libook
    libook
    Nov 24, 2023
    21
    自己的项目绝大部分情况用 conventional commits ,别人的项目就 git log 看看过往提交风格,模仿着写,如果过往提交没有统一风格,就按照自己喜好写。

    这东西跟项目管理情况是息息相关的。
    比如开发一个本地特色的项目,也大可不必坚持用英文,只要能快速、准确、工整表达核心信息就可以了。
    再比如写的可能不是程序,而是个文档项目,只是想用 Git 来做版本控制,那么可以自己找或设计一套适合文档的提交风格。
    hugojtchen
    hugojtchen
    Nov 24, 2023
    22
    husky 做 git 钩子拦截
    commitlint 做校验信息
    git cz 填写内容
    leroy20317
    leroy20317
    Nov 24, 2023
    23
    commitlint + @commitlint/config-conventional
    Jony4Fun
    Jony4Fun
    Nov 24, 2023
    24
    <summary in 50 bytes>

    <description in 72 bytes per line>
    crazyTanuki
    crazyTanuki
    Nov 24, 2023
    25
    直接用哈士奇
    cutiechi
    cutiechi
    Nov 24, 2023
    26
    有规范,并且 commit message 也会链接 tapd
    churchill
    churchill
    Nov 24, 2023
    27
    规范不规范的我不知道,有的同学啊,提交倒是写了介绍,但点开一看,内容完全对不上
    咱不如每次都写“a bunch of code”,还省事
    ugu
    ugu
    Nov 24, 2023
    28
    angular 规范 用 commitlint 约束
    fpcxsun
    fpcxsun
    Nov 24, 2023
    29
    Description:
    TraceNo:
    recying5566
    recying5566
    Nov 24, 2023
    30
    @hez2010 这是什么编辑器?
    hez2010
    hez2010
    Nov 24, 2023
    31
    @recying5566 Visual Studio 2022 的 17.9 版本
    roycestevie6761
    roycestevie6761
    Nov 24, 2023
    32
    @hez2010 vs 越来越牛逼了
    noyidoit
    noyidoit
    Nov 24, 2023
    33
    @hez2010 https://imgur.com/a/oT6Ee8O 这两周 VSCode 直接把这个功能集成进 source control 了
    nwu2Cv8OZ2MZMg39
    nwu2Cv8OZ2MZMg39
    Nov 25, 2023
    34
    @noyidoit 是不是必须开通 GitHub Copilot?
    noyidoit
    noyidoit
    Nov 25, 2023
    35
    @VikingX 我原本以为是 Copilot 引入的,但你这么一说,我禁用插件测试了一下,发现是 "GitLens — Git supercharged v14.5.1",抱歉前面的信息造成了误解
    god
    god
    Nov 25, 2023 via iPad
    36
    ## https://github.com/Nutlope/aicommits
    aicommits --type conventional

    ## https://github.com/di-sukharev/opencommit
    oco

    ## https://github.com/zurawiki/gptcommit
    git commit -a

    ## https://github.com/appleboy/CodeGPT
    codegpt commit --preview --template_file your_file_path

    ## https://github.com/RomanHotsiy/commitgpt
    npx commitgpt
    levelworm
    levelworm
    Nov 25, 2023 via Android
    37
    我自己的规范:

    commit 加 jira link ,简单说明,长度不超过 GitHub 标题的长度(其实他的标题可以很长,但是 commit 的时候好像有个固定长度,超了就自动进入 description 了)。
    Conty
    Conty
    Nov 25, 2023 via Android
    38
    所有人不允许直接 git push 。用自己写的系统做 code review 。review 里面要写明白细节。
    netabare
    netabare
    Nov 25, 2023 via Android❤️1
    39
    不知道 commit message 里面塞表情符号算不算规范的一部分
    boomer995
    boomer995
    Nov 25, 2023
    40
    💥 feat(compiler): add 'comments' option
    🐛 fix(compiler): fix some bug
    📝 docs(compiler): add some docs
    🌷 UI(compiler): better styles
    🏰 chore(compiler): Made some changes to the scaffolding
    🌐 locale(compiler): Made a small contribution to internationalization
    qloog
    qloog
    Nov 25, 2023
    41
    要写的。方便日后 有 问题时查看 commit log , 如果是开源项目,便于日后自动生成 release note. 比如: https://github.com/go-eagle/eagle/releases
    dayeye2006199
    dayeye2006199
    Nov 25, 2023
    42
    没有,只要求交 PR 的时候 squash 成一个 commit ,然后信息需要有一定的描述性。
    你说 PR 太大,没法放一个 commit ,那要重新考虑这个 PR 的任务范围划分
    lazydog
    lazydog
    Nov 25, 2023
    43
    用 git 官方推荐的,但是我们组 99%的人胡逼写。
    nwu2Cv8OZ2MZMg39
    nwu2Cv8OZ2MZMg39
    Nov 25, 2023
    44
    @noyidoit 要用这个功能,是不是需要填入自己的 GPT APIKeys?还是说不需要额外购买 GPT 了?
    KratosOmega
    KratosOmega
    Nov 25, 2023
    45
    有的,还有 git hook 脚本自动检查,不符合规范不给 commit
    grumpyFish
    grumpyFish
    Nov 25, 2023
    46
    11.25......11.26........
    update
    fix
    bugfix
    jeesk
    jeesk
    Nov 25, 2023
    47
    zengguibo
    zengguibo
    Nov 25, 2023
    48
    带上任务或是 bug 的 ticket id ,这样就好管理一些
    mosanHZ
    mosanHZ
    Nov 25, 2023
    50
    看实际情况,假如你的 commit 除了你没人看,你怎么写都行,也没人会叼你
    a632079
    a632079
    Nov 25, 2023
    52
    用法的 conventional commitlint 。

    https://github.com/conventional-changelog/commitlint
    alanhe421
    alanhe421
    Nov 25, 2023
    53
    nodejsexpress
    nodejsexpress
    Nov 25, 2023
    54
    自己的 git 也会写一些关键词,起码以后看起来知道这里干了什么。
    Zchary
    Zchary
    Nov 25, 2023
    55
    feat: fix ** bug.
    Alliot
    Alliot
    Nov 25, 2023
    56
    noyidoit
    noyidoit
    Nov 25, 2023
    57
    @VikingX 就目前而言,这个功能不需要填入 APIKeys
    R4rvZ6agNVWr56V0
    R4rvZ6agNVWr56V0
    Nov 26, 2023
    58
    以前用 Fabricator 协作过,所以都是 fabricator 上的 comments
    810244966
    810244966
    Nov 26, 2023
    59
    跟着项目来,有些项目写的很细就写很细,有些新增功能就打个 1 ,修改就打个 fix ,我也跟着
    lslqtz
    lslqtz
    Nov 26, 2023
    60
    比较喜欢用 Module: Comment.
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   2142 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 112ms · UTC 13:43 · PVG 21:43 · LAX 05:43 · JFK 08:43
    ♥ Do have faith in what you're doing.