update:about-git

This commit is contained in:
dichgrem
2025-03-18 20:42:10 +08:00
parent 9011e83507
commit 812d120f8b

View File

@ -291,3 +291,63 @@ git@github.com: Permission denied (publickey).
```
ssh-add ~/.ssh/id_rsa
```
## commit规范
1. 提交信息的基本格式
- Header头部
格式:
```
<type>[可选的 scope]: <简短描述>
```
type 表示提交类型feat新功能、fix修复bug等。
scope 是可选的,用于指出变更影响的模块或范围。
简短描述 用于概述本次提交的核心内容,通常使用祈使语气。
- Body正文
用于详细说明变更的动机、方法以及可能的影响,建议每行不超过 72 个字符。
- Footer脚注
可选部分,用来引用相关 issue、任务或说明破坏性变更例如BREAKING CHANGE: ...)。例如:
```
Fixes #123
```
这可以在提交后自动关闭相关问题。
2. 常见的 Commit 类型
```
feat新功能的添加
示例feat(user): 添加用户注册功能
fix修复 Bug
示例fix(parser): 修复解析错误导致程序崩溃
docs文档相关的修改
示例docs(readme): 更新使用说明
style代码格式、排版等不影响代码逻辑的调整
示例style: 优化代码缩进和空格
refactor代码重构不涉及新功能或 Bug 修复
示例refactor: 优化数据处理逻辑
perf性能优化
示例perf: 提升数据查询速度
test添加或修改测试代码
示例test: 补充用户登录单元测试
build构建相关的变更如依赖管理、构建脚本等
示例build: 更新 webpack 配置
ci持续集成相关的修改
示例ci: 调整 GitHub Actions 配置
chore其他杂项维护不涉及源代码或测试文件的修改
示例chore: 更新项目依赖
revert回滚到上一个版本的提交
示例revert: 撤销上次提交
```