Skip to content
本页导航

GIT提交规范

提交规范

  • feat: 新功能(feature)
    • add: 新增功能、文件等
    • remove: 移除功能、文件及相关内容
  • fix: 修补bug
  • docs: 文档、注释修改
  • style: 格式(删除代码空格、缩进等,不影响代码运行的变动)
  • refactor: 重构(即不是新增功能,也不是修改bug的代码变动)
  • perf: 性能优化
  • test: 增加测试
  • chore: 构建过程或辅助工具的变动
  • revert: 回退
  • merge: 代码合并
  • build: 打包
  • release: 发布版本

示例:

bash
git commit -m "feat: 新增了...功能"     // 新功能
git commit -m "fix: 指数选基..."        // bug修复
git commit -m "style: 指数选基..."      // 样式修改
git commit -m "test: 测试指数选基..."   // 测试代码
git commit -m "feat: 新增了...功能"     // 新功能
git commit -m "fix: 指数选基..."        // bug修复
git commit -m "style: 指数选基..."      // 样式修改
git commit -m "test: 测试指数选基..."   // 测试代码

校验

  • 前端: 提交代码必须通过 eslint 的校验

配置

  • 用户名邮箱必须设置为公司分配的信息,否则无法提交
  • 和项目无关的文件及文件夹,如*.iml、.vscode等不允许提交至远程仓库

示例

git配置

在用户目录下新建 .gitconfig 文件,示例如下:

bash
[user]
	name = ***
	email = ***
	
[core]
	autocrlf = input
	ignorecase = false
	excludesfile = ~/.gitignore_global
[user]
	name = ***
	email = ***
	
[core]
	autocrlf = input
	ignorecase = false
	excludesfile = ~/.gitignore_global

全局忽略配置

在用户目录下新建 .gitignore_global 文件,示例如下:

bash
# Mac
.DS_Store
.DS_Store?
# IDEA
*.iml
.idea
# VSCode
.VSCode
.VSCondeCounter*
# 前端
node_modules
# Java
.flattened-pom.xml
# Mac
.DS_Store
.DS_Store?
# IDEA
*.iml
.idea
# VSCode
.VSCode
.VSCondeCounter*
# 前端
node_modules
# Java
.flattened-pom.xml

lhiro