Missing Necessary Knowledge for CS Students
  • 前言
  • 基础知识
    • Git
      • 安装
      • 基本命令
      • Git Commit Template
      • GitHub
    • Vim
      • 安装
      • 教程
    • 学会获取信息
      • 学会使用英文搜索信息
      • 阅读官方文档
    • 调试
      • 断点调试
      • 网页调试
    • 测试
    • 代码规范
      • 不同编程语言的代码规范
      • 注释与文档
    • 工具链
      • 代码格式化工具(Formatter)
      • 代码检查工具(Linter)
      • 包管理器与依赖管理工具
      • 打包工具
    • 抽象
      • 封装
      • 重构
      • 究竟什么是抽象
    • 编程语言
      • 编译器与解释器
      • 强类型与弱类型
      • 静态类型与动态类型
      • 面向对象与函数式编程
    • 其他
      • Markdown
      • Jupyter Notebook
      • 虚拟机与 Docker
      • CI/CD
  • 附:一些常见工具的使用
    • Scoop
Powered by GitBook
On this page
  1. 基础知识
  2. Git

Git Commit Template

Previous基本命令NextGitHub

Last updated 2 years ago

关于要如何规范 Git 中提交(commit)时的信息格式,一直以来都是个比较让人头疼的问题。在很多项目中,尽管使用了 Git 做版本控制,但由于大家提交代码时都很随心所欲,提交信息(commit message)不能够清晰地表达本次提交所做的修改,因而仍旧不容易规范地管理仓库中的代码。

后来,为了解决这个问题,许多项目制定了对 commit message 格式的要求,甚至许多项目在将代码并入仓库前会检查 commit message 格式是否规范,如果不规范,则拒绝入库。而被大家普遍接受的一种格式是知名前端框架 Angular 仓库所采用的格式。这也被称为 Git Commit Template.

可以看到,在上图中,Angular 仓库的 commit message 看起来很清晰直观,这就是 Git Commit Template 带来的价值。

在 VS Code 中,可以通过 Git Commit Template 插件按照模板生成符合规范的 commit message.

Angular's Commit History
VS Code Extension for Git Commit Template