From 812d120f8bbc4dd1d828297bc0896f8df06aaa37 Mon Sep 17 00:00:00 2001 From: dichgrem Date: Tue, 18 Mar 2025 20:42:10 +0800 Subject: [PATCH] update:about-git --- content/about-git.md | 60 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/content/about-git.md b/content/about-git.md index e0c614d..45d2ccf 100644 --- a/content/about-git.md +++ b/content/about-git.md @@ -291,3 +291,63 @@ git@github.com: Permission denied (publickey). ``` ssh-add ~/.ssh/id_rsa ``` +## commit规范 + +1. 提交信息的基本格式 + +- Header(头部) +格式: +``` +[可选的 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: 撤销上次提交 +``` \ No newline at end of file