欢迎您光临本小站。希望您在这里可以找到自己想要的信息。。。

git提交注释规范

软件工程 water 1265℃ 0评论

git初始化

首先下载安装git,配置好公私密钥和github

git命令

git init
git remote add origin [远程库地址]
git pull origin master
git add .
git commit -m “注释”
git push origin master

其他:
git status
git log
git branch
git checkout
git merge

git 注释 格式:

<type>(<scope>): <subject>
// 空一行
<body>

type(必需)

用于说明 commit 的类别

br: 此项特别针对bug号,用于向测试反馈bug列表的bug修改情况
feat:新功能(feature)
fix:修补
docs:文档(documentation)
style: 格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test:增加测试
chore:其他的小改动. 一般为仅仅一两行的改动, 或者连续几次提交的小改动属于这种
revert:feat(pencil): add ‘graphiteWidth’ option (撤销之前的commit)
upgrade:升级改造
bugfix:修补bug
optimize:优化
perf: Performance的缩写, 提升代码性能
test:新增测试用例或是更新现有测试
ci:主要目的是修改项目继续完成集成流程(例如Travis,Jenkins,GitLab CI,Circle)的提交
build: 主要目的是修改项目构建系统(例如glup,webpack,rollup的配置等)的提交

scope(可选)

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

subject(必需)

subject是 commit 目的的简短描述,不超过50个字符。
以动词开头,使用第一人称现在时,比如change,而不是changed或changes
第一个字母小写
结尾不加句号(.)

(可选)部分

是对本次 commit 的详细描述,可以分成多行

转载请注明:学时网 » git提交注释规范

喜欢 (1)or分享 (0)

您必须 登录 才能发表评论!