美文网首页
Git提交规范

Git提交规范

作者: 梁上龙 | 来源:发表于2018-09-27 08:29 被阅读0次

    开发规范

    分支管理:

    1. feature release master,
    2. tag标识生产部署

    运维平台:

    1. 使用python3.6
    2. 内部小组自测、发版

    commit规范

    争取做到理解代码业务逻辑,通过提交记录就可以搞清楚,而不是读代码
    当前业界应用的比较广泛的是 Angular Git Commit Guidelines

    具体格式为:

    <type>: <subject>
    <BLANK LINE>
    <scope>
    <BLANK LINE>
    <body>
    <BLANK LINE>
    <footer>
    
    1. type: 本次 commit 的类型,诸如 bugfix docs style 等
    2. scope: 本次 commit 波及的范围
    3. subject: 简明扼要的阐述下本次 commit 的主旨,在原文中特意强调了几点
      1. 使用祈使句,是不是很熟悉又陌生的一个词,来传送门在此 祈使句
      2. 首字母不要大写
      3. 结尾无需添加标点
    4. body: 同样使用祈使句,在主体内容中我们需要把本次commit 详细的描述一下,比如此次变更的动机,如需换行,则使用 |
    5. footer: 描述下与之关联的 issue 或 break change

    Type的类别说明:

    feat: 添加新特性
    fix: 修复bug
    docs: 仅仅修改了文档
    style: 仅仅修改了空格、格式缩进、都好等等,不改变代码逻辑
    refactor: 代码重构,没有加新功能或者修复bug
    perf: 增加代码进行性能测试
    test: 增加测试用例
    chore: 改变构建流程、或者增加依赖库、工具等

    Commit messages格式范例

    # 标题行:50个字符以内,描述主要变更内容
    #
    # 本次修改影响范围
    #
    # 主体内容:更详细的说明文本,建议72个字符以内。 需要描述的信息包括:
    #
    # * 为什么这个变更是必须的? 它可能是用来修复一个bug,增加一个feature,提升性能、可靠性、稳定性等等
    # * 他如何解决这个问题? 具体描述解决问题的步骤
    # * 是否存在副作用、风险? 
    #
    # 如果需要的化可以添加一个链接到issue地址或者其它文档
    复制代码
    

    脚本内容范例

    #!/bin/bash or #!/usr/bin/env python
    ##
    #功能介绍
    ##
    #Crated:
    #Auther:
    xxxxxxxxxxxxxxxxxxxxxxxx
    

    对于python来说,还是争取选择操作系统已经内置的python版本和库,使用虚拟环境,最小化对其他系统的影响

    repo管理

    1. 每个项目是一个repo, 分支对应不同用途、环境

    2. 每个repo应当包含一个README, 使用markdown语法,主流文档编写语法,具体参考这里

    相关文章

      网友评论

          本文标题:Git提交规范

          本文链接:https://www.haomeiwen.com/subject/ewmsoftx.html