V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
weimo383
V2EX  ›  开源软件

开源项目一定要 commit 很规范吗?

  •  
  •   weimo383 · 2023-05-23 10:55:46 +08:00 · 2208 次点击
    这是一个创建于 540 天前的主题,其中的信息可能已经有所发展或是发生改变。

    我都是直接做一下交一个 wip commit

    18 条回复    2023-05-23 17:46:32 +08:00
    Dididadada
        1
    Dididadada  
       2023-05-23 11:00:45 +08:00
    如果你希望别人参与开发的话尽量规范吧,只是分享自己的成果无所谓
    wandehul
        2
    wandehul  
       2023-05-23 11:01:08 +08:00
    首先第一条,全都是 fix 或者 update 的 commit 肯定是没有意义的
    weimo383
        3
    weimo383  
    OP
       2023-05-23 11:04:40 +08:00
    @wandehul 我会懒得想这次修改到底干了什么 所以一律 wip 只有大功能来了才会 feat 说明一下
    ksc010
        4
    ksc010  
       2023-05-23 11:13:27 +08:00
    @weimo383 每次 写 commit 有个好处是 会迫使你看修改了哪些地方
    然后看下有没有被误提交的代码
    IvanLi127
        5
    IvanLi127  
       2023-05-23 11:16:53 +08:00 via Android
    不用呀,只要不是协作项目就不需要。开源和协作可以相互切割哒
    mineralsalt
        6
    mineralsalt  
       2023-05-23 11:17:11 +08:00
    可以不规范, 但是公开给别人看的东西, 如果不规范, 我自己会觉得丢人
    likunyan
        7
    likunyan  
       2023-05-23 11:18:35 +08:00
    我直接 233
    InDom
        8
    InDom  
       2023-05-23 11:22:09 +08:00   ❤️ 1
    我是逐段选择需要提交的代码,对每一段修改做了什么都写在 commit 中。

    哪怕修改了密码的长度,一般都会有这么多提交说明:

    ```
    修改 用户密码的长度限制由 24 改为 32 位

    修改 数据库 users 表 password 字段长度(对,我们存明文的)
    修改 前端密码校验逻辑的长度校验范围
    修改 用户登陆接口的密码长度检查范围
    ```
    huijiewei
        9
    huijiewei  
       2023-05-23 11:25:28 +08:00
    为啥要写 commit?
    echo1937
        10
    echo1937  
       2023-05-23 11:26:10 +08:00   ❤️ 4
    别说开源项目了,大一点的企业内部项目,不搞一搞规范都要气死人。

    你见过 feature 分支和 main 分支互相 merge 导致多龙戏珠的壮观 log 吗?
    Jaosn
        11
    Jaosn  
       2023-05-23 11:31:04 +08:00
    等你需要 reset 的时候,你怎么知道自己要到那个 commit ?
    Asakijz
        12
    Asakijz  
       2023-05-23 11:36:25 +08:00
    不一定吧,能看懂就行
    qsnow6
        13
    qsnow6  
       2023-05-23 11:37:06 +08:00
    让 GPT 帮你写
    BingoXuan
        14
    BingoXuan  
       2023-05-23 11:38:51 +08:00
    @echo1937
    多龙戏珠的画面出来了,差点没把握笑死
    Jirajine
        15
    Jirajine  
       2023-05-23 11:51:44 +08:00
    和开不开源没关系,等你需要 review 、重构之前的代码的时候,下次你就会写的很规范了。
    jim9606
        16
    jim9606  
       2023-05-23 13:39:02 +08:00 via Android
    commit 一般只有合作开发者会看,用户一般只看 release notes 。
    我觉得是没必要太详细的,一行说清楚。如果觉得你的描述很重要值得存档,应该放文档或者代码注释里。
    不要把多个功能混在一个 commit 里,例如功能 a 做 20 %功能 b 做 20 %放一个 commit 里。
    重大功能开发可以考虑开一个 issue ,然后 commit 引用 issue 来跟踪。
    diagnostics
        17
    diagnostics  
       2023-05-23 13:43:00 +08:00
    不是开源项目要规范 commit ,而是代码版本化管理,规范化 commit 后,你版本化才有意义。

    开源项目只是把底裤给别人看而已
    otakustay
        18
    otakustay  
       2023-05-23 17:46:32 +08:00
    你做 wip commit 就在独立分支上,然后再 squash merge 回主干的时候写清楚呗
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   5383 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 29ms · UTC 07:13 · PVG 15:13 · LAX 23:13 · JFK 02:13
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.