中小型项目GIT规范🌈

1.Git 提交日志格式规范

1.1 基本的 message 格式

<type>(<scope>): <subject> 
[optional body]
<footer>

其中首行必选，scope、body 和 footer 可选。

1.2 字数限制

• header（首行）：只有一行，不超过 50 个字符
• body：每行不超过 72 个字符
• footer：每行不超过 72 个字符

1.3 header --> type

type 用来描述本次提交的改动类型，可选值及对应含义如下：

feat：新功能（feature）
fix：修复问题（bug fix）
docs：文档更新
style：代码格式（不影响代码运行的变动）
refactor：代码重构（既不是修复bug也不是添加新功能的代码更改）
perf：性能优化
test：添加测试或更新测试
build：构建系统或外部依赖项的更改（如webpack, npm）
ci：持续集成相关的变动
chore：其他不修改src或测试文件的更改
revert：回滚某次提交

1.4 header --> scope

scope 用来描述本次提交所涉及到的改动范围（例如模块、功能或其他任何限定的范围）。

1.5 header --> subject

subject 用来概括和描述本次提交的改动内容

1.6 body

日志的内容主体 body 用来描述详细的提交内容 1.---- 2.---- 3.----

1.7 footer

用于代码评审过程记录、作者签名等

Reported-by: User1 <user1@example.com>
Helped-by: User2 <user2@example.com>
Reviewed-by: User3 <user3@example.com>
Signed-off-by: Author <author@example.com>

2. Git 分支命名规约

2.1 临时分支

{type}-{issue id}-the-thing-you-do

• type：和上文 1.3 章节中的 type 保持一致
• issue id：与分支内容相关的 issue id，如果无关，则可以忽略

2.2 多版本分支命名

• 1.0.0-stable
• 2.0.0-stable

3 Git tag 命名规约

• Git tag 就是通过语义化的名称来给仓库标注一个个具体的节点。
• 与此同时还可以根据标签名称来大致了解当前项目的兼容性和迭代情况。

使用附注标签

git tag -a v1.2.3 -m "发布XXX模块"