版本库约定

版本库约定

一、版本管理软件

版本库的软件主要使用:SVN & GIT。
GIT 负责管理软件工程的源代码资料。
SVN 负责管理产品文档、设计文档、备份资料等非研发进行中的代码资料。

二、GIT约定

2.1、提交信息约定

1、语法

常规方式    Type: Subject
需求关联    Type: --story={zendaoId} Subject
任务关联    Type: --task={zendaoId} Subject
缺陷关联    Type: --bug={zendaoId} Subject 其中 {zendaoId} 值为与 禅道 的关联。

2、Type

  • feat 新功能,主要追随产品需求的变更,含 sql 脚本。
  • fix 修复缺陷,含 sql 脚本。
  • docs 文档,一般用于 .md、.doc、.txt 之类的文档。
  • style 格式(含注释),不影响代码运行的变动,如果做的事情和 feat/fix 并在一起,则优先用 feat/fix,即 style 优先级较低。
  • refactor 重构,既不新增功能,也不修改缺陷的代码变动
  • test 测试,无论测试部分进行新增、修改、删除、重构,都归于此。
  • chore 构建过程或辅助工具的变动。

3、Subject
Subject 即为文字内容,应尽可能不要超过 50 个字符,也建议用中文来描述。如果第一个字符是字母类型,那第一个字符必须得大写。
Subject 文字结尾不加任何符号,例如 ;、。、. 等等。
Subject 文字内容中间尽可能不要加空格。

4、示例

feat: 新增单据提交时的消息推送
fix: 修复单据校验时,缺少message字段,导致的NPE事件
chore: 工程增加common依赖包
fix: --task=1004839 --user=黄烜 WebHooks测试

评论

暂无

添加新评论