search

haitaodesign / vue-cli-base

基于Vue CLI 的企业级快速初始化项目模板
5 stars 1 forks source link

[New Feature] Git commit 规范调研 #13

Open haitaodesign opened 5 years ago

haitaodesign commented 5 years ago
  1. 阅读其他团队对于Git Commit 规范的实践文章
  2. 提炼适合团队的规范内容
  3. 对于合理的部分进行整理总结文档
  4. 建立演示仓库，通过可视化的方式展示规范流程
  5. 实际项目集成案例演示
  6. 如何落地？
haitaodesign commented 5 years ago

参考文档

  1. Angular规范
  2. git commit 代码提交规范
  3. git-commit-style-guide
  4. conventionalcommits

    工具

  5. commitizen
  6. conventional-changelog
  7. standard-version
  8. commitlint
  9. 编辑器插件支持
haitaodesign commented 5 years ago

目的

  1. 统一团队 Git Commit 提交格式，便于代码review，版本发布以及日志自动化生成等
  2. 统一团队的 Git WorkFlow，包括分支使用，tag，issue规范等
haitaodesign commented 5 years ago

总体方案

  1. 以Angular的Git commit 日志为基本规范
  1. commit 提交时，友好的类型选择提示
  2. 不符合规范的提交信息的验证（CI集成）
  3. changelog 日志自动化生成
  4. 若开源社区的主流方案不符合团队的需求，可进行自定义开发
  5. 扩展：语义化版本发布 semantic-release
haitaodesign commented 5 years ago

实施方案

  1. 确定git commit message提交规范标准
  2. 集成commitlint提交信息规范检查
  3. 集成commitizen，友好的命令行交互式提示
  4. 集成changelog, 自动化生成CHANGELOG.md
  5. 编译器插件支持

前端项目集成演示仓库 ：https://github.com/haitaodesign/vue-cli-plugin-moor-commit

目前没有实现语义化版本自动化发布流程，需要进一步通过CI集成

haitaodesign commented 5 years ago

如何落地？

  1. 项目集成（Node 项目，非 Node 项目）
  2. CI集成
  3. 自觉执行