• 导航

Git 使用规范

前端杂烩 2024-06-05 104 次浏览

背景

在现有开发中,开发人员在使用git过程中,大部分根据自己的git使用习惯来完成对应的代码的开发,这样会带来以下几个问题:
1)各个人员使用方式不统一,不方便对各项研发数据的统计;
2)部分git 使用命令可能会带来代码分支被污染的问题,从而影响线上稳定。
这里给出了 git 使用的相关规范,并将该部分的规范融合到了分支开发规范中。

git 使用规范详情

1)开发前
【强制】 项目开发采用分支开发方式,新需求开发前,从Master拉取分支;
【强制】项目功能需求,开发分支命名采用 feature 开头方式,如 feature-XX、feature/XX,不区分大小写;
【强制】BUG修复需求,开发分支命名采用 bugfix 开头方式,如 bugfix-XX、bugfix/XX,不区分大小写。
2)开发中
【强制】 主干分支的回退应该使用git revert的方式, 禁止使用 -f 命令;
【强制】合并本地多个 commit, 本地提交可能有多个 commit,建议再推送到远端之前合并这些 commit,并且根据 commit 的消息格式要求,填写规范的 commit 消息;
【建议】对于周期长的项目,不建议频繁push到远端,push到远端后不建议执行 -f 操作。
3)开发后
【强制】 提交代码时,不要使用 git amend 、git rebase 等命令;
【强制】 自动生成的代码,不要提交到git。
【建议】提交代码时,对必须要提交的自动生成代码,建议放在特定的目录。
【建议】commit 信息,需包含标题和描述两个部分,详细说明改动的情况。

git 使用规范落地

git 使用规范是分支开发规范的一部分,我们在实际操作中,已将其嵌入到分支代码规范中,另外会定期的检查各项指标的正确性。