V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
northisland
V2EX  ›  问与答

请教各位,如何写提交的标题,才显得足够优雅?

  •  1
     
  •   northisland · 2017-10-30 15:44:05 +08:00 · 1730 次点击
    这是一个创建于 2362 天前的主题,其中的信息可能已经有所发展或是发生改变。

    工作团队的 VCS 有年头了,还在用 SVN。

    得定期提交更新。

    平时的提交,总结起来,可能有如下几个类型:

    • 实现功能

    • 修复 bug

    • 编写文档

    • 重构已有功能

    • 更新数据

    我想学习一下各位是怎么写提交的标题的;而且特别想知道,用英文怎么来搞这一套。

    提前谢过。


    好像 https://github.com/erlang/otp/wiki/Writing-good-commit-messages 这里提到过,一份好的提交有三个要素:

    1. 加快别人了解或审核( review process )
    2. 有助于生成版本发布报告( release note )
    3. 有助于日后的软件维护( future maintainers of Erlang/OTP,知识有限,看不懂 Erlang 和 OTP 是要干嘛)
    7 条回复    2017-11-07 21:17:23 +08:00
    SourceMan
        1
    SourceMan  
       2017-10-30 16:08:32 +08:00
    优雅能提高工作效率、降低交流成本吗?
    coderluan
        2
    coderluan  
       2017-10-30 16:20:15 +08:00   ❤️ 1
    你看的 wiki 是” https://github.com/erlang/otp/“ 下的的啊,自然是维护 Erlang 和 OTP,哈哈哈。
    LxExExl
        3
    LxExExl  
       2017-10-30 16:22:33 +08:00 via iPhone   ❤️ 1
    震惊!这个 bug 我用了 3 行就修复了!
    coderluan
        4
    coderluan  
       2017-10-30 16:25:35 +08:00   ❤️ 1
    没啥特殊要求的话,随便 google ” How to Write a Git Commit Message “就行了,肯定比这地方大家随便说几句好。
    northisland
        5
    northisland  
    OP
       2017-10-30 17:33:48 +08:00
    @coderluan 下班时间顶起来,希望看见更多手写的意见。

    @LxExExl 戳中笑点,能否透露一下被 leader 发现后的故事~

    @SourceMan Beautiful is better than ugly.
    zthxxx
        6
    zthxxx  
       2017-11-07 10:14:49 +08:00   ❤️ 1
    neoFelhz
        7
    neoFelhz  
       2017-11-07 21:17:23 +08:00 via Android   ❤️ 1
    @zthxxx
    不完全是翻译。其实我们不仅学习了 Vue 和 Angular,还学习了阿里的 eggjs 的提交记录,等等。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   3189 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 48ms · UTC 13:40 · PVG 21:40 · LAX 06:40 · JFK 09:40
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.