Skip to content

Git操作

git提交信息规范化

为了提高代码管理的规范性和追踪的便利性,推荐采用以下步骤约束提交信息的格式,确保每次提交都能清晰地描述其目的和内容。

检查当前状态

在添加更改到暂存区之前,先检查工作区的状态,确保所有变更都是预期的。

bash
git status

选择性添加更改

推荐根据实际需要,选择性地将文件添加到暂存区。这样做可以避免不必要的文件被包含在提交中。

bash
git add <文件路>
bash
git add <文件路径1> <文件路径2>
bash
git add .

确认暂存区状态

在提交之前,再次确认暂存区的状态,确保所有预期更改都已经添加。

bash
git status

交互式提交信息构建

执行 pnpm run commit 按照提示交互式的构建 commit message

  选择你要提交的类型 : Use arrow keys or type to search
 feat:     ✨  新增功能
 types:    🎨  类型相关
 docs:     📝  文档更新
 style:    💄  代码格式
 refactor: ♻️   代码重构
 perf:     ⚡️  性能提升
 test:     ✅  测试相关
 build:    📦️  构建相关
 release:  🔖  版本提升
 ci:       🎡  持续集成
 revert:   ⏪️  回退代码
 chore:    🔨  其他修改
 init:     🎉  初始化

  选择一个提交范围: Press <space>|<right> to select, <enter> to submit
 docs
 utils
 project
 ci
 deploy
 other

  填写简短精炼的变更描述 :
  描述你本次提交的信息

  填写更加详细的变更描述(可选)。使用 "|" 换行 :
  可以省略 

  Is any BREAKING CHANGE (add "!" in header) (optional) ? (y/N)
  N 

  选择关联issue前缀(可选): Use arrow keys or type to search
 skip
 custom

推送到远程仓库

最后,将提交推送到远程仓库。

bash
git push

通过以上步骤,可以有效地管理和约束提交信息的格式,确保项目的变更历史清晰、规范,便于团队协作和后期维护。