-
Notifications
You must be signed in to change notification settings - Fork 30
Expand file tree
/
Copy pathgitcommit_template
More file actions
39 lines (25 loc) · 1.49 KB
/
gitcommit_template
File metadata and controls
39 lines (25 loc) · 1.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# commit 格式
# type(scope): subject
# 即:commit类型(影响范围): 具体描述
# 建议使用英文 commit,举例:
# fix(log): fix the format error of log when printing
# doc: increase the readme of each folder in this repo
# type(必须)
# type 指明 git commit 的类别,应该使用以下类型,也可根据团队自行增减
# feat: 新增功能
# fix: 修复 bug
# doc: 仅仅修改了文档,比如 README 等等
# test: 增加/修改测试用例,包括单元测试、集成测试等
# style: 修改了空行、缩进格式、引用包排序(不改变代码逻辑)、文件夹变更、文件名变更等
# perf(全称performance): 优化相关内容,比如提升性能、体验、算法等
# ref(全称refactor): 代码重构,没有新功能或者bug修复。但是架构有很大的调整。
# chore: 项目依赖升级、配置文件调整、构建脚本优化等不影响项目功能的杂务
# revert: 回滚到上一个版本
# merge: 代码合并
# ana(或者analysis): 分析源码时,一些必要的注释
# tmp(或者temporary): 临时保存
# scope(可选)
# 对于本项目来说可以是 3rd, log, operator(简写op), tensor, mat, comm, model, layer, test 等
# scope用于说明 commit 影响的范围,根据不同项目有不同层次描述。若没有特殊规定,也可以描述影响的哪些功能等。
# subject(必须)
# subject 是 commit 目的的简短描述,不超过 80 个字符。