Git 版本管理的 commit 规范

本贴最后更新于 902 天前,其中的信息可能已经物是人非

在 github 上偶然翻到一个项目,作者附注了该项目的 commit 规范,觉得写的挺好的,转存下以供学习

项目规范

git commit

一个 commit 尽可能只做一件事

  1. added: 添加,一般在添加了新功能时使用
  2. improved: 改进,一般在优化和改进代码时使用
  3. refactored:重构,一般在优化代码结构和设计时使用
  4. fixbug: 修复 bug,一般在修复 bug 时使用

命名规范

  1. 文件名统一用小驼峰法,例如:userRegister
  2. 路由命名统一用"-",例如:user-register
  3. 包名统一用小写字母,例如:student

版本约定

  1. 采用主版本号.子版本号.修正版本号,比如:V1.2.1
  2. 修正版本号一般在修复 bug 时使用
  3. 子版本号一般在添加了新功能时使用
  4. 主版本号一般是在积累了较多新功能且代码稳定时使用

更新日志

  1. added: 添加的新功能
  2. changed: 功能的变更
  3. fixed: 修改的 bug
  4. security: 修改的关于安全的 bug
  5. removed: 删除的功能
  • Git

    Git 是 Linux Torvalds 为了帮助管理 Linux 内核开发而开发的一个开放源码的版本控制软件。

    209 引用 • 358 回帖 • 1 关注

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...