VFT 项目基本开发流程与 Git 提交规范

开发前提

• node 版本大于等于 16
• pnpm 版本大于等于 8.0.0

全局安装 pnpm

npm install -g pnpm

安装项目

此过程首次可能会执行时间较长请耐心等待

pnpm i

运行项目代码

pnpm dev

GIT 提交规范

信息提交格式为

<commit-type>[(<scope>)]: <commit-msg> (#禅道号)

• commit-type：必填项，为对应提交类型，这里约定了feat,fix,docs,style,refactor,perf,test ,build,ci,chore,types,wip,revert这些类别，具体代表的含义可以查看下面的提交类别说明。
• scope：可选必填项，用于描述改动的范围，如果一次 commit 修改多个模块，建议拆分成多次 commit，以便更好追踪和维护。
• commit-msg: 必填项，为提交信息的简要说明。
• 禅道号: 必填项，每一次提交必须对应一个禅道号，如果某次修改没有禅道号对应，请使用#000 。需要注意的是，禅道号必须使用#开头，并且一个提交只能写一个禅道号，在有多个禅道 bug 的情况下，请将不同的 bug 进行拆分提交。

提交示例

git commit -m "feat: 添加了某某功能"

git commit -m "fix: xxx修复"

提交类别

GIT 使用流程

1. 如果自己分支不干净时，使用git stash添加暂存，如果是干净的可以跳过这一步；
2. 在分支上执行git pull origin dev --rebase，它的作用是将dev分支上的变动rebase到自己的分支上；
3. 如果出现冲突，解决后git rebase --continue 如果放弃此次 reabase，使用git rebase --abort取消；
4. 如果执行了第一步中的stash，此时还需要执行git stash pop恢复暂存的修改，如未执行步骤 1 则忽略，如出现冲突则继续解决冲突；
5. 最后提交代码到远端仓库 git push origin [branch-name]；
6. 到网页上，将自己分支的最新代码与 dev 对比，建一个 PR；
7. 预览当前 PR 的内容，并 merge 到 dev 分支。

rebase 出现冲突

1. 解决 conflict，然后继续 rebase git rebase --continue
2. 放弃此次 rebase 操作 git rebase --abort

不想提交的代码

1. 将代码缓存到暂存区 git stash
2. 将暂存的代码取出来git stash pop

误操作 git 导致代码丢失

1. 使用git reflog获取所有历史操作日志
2. 使用git cherry-pick [reflog-id]恢复某个分支的代码

更多详细用法请参考：https://www.liaoxuefeng.com/wiki/896043488029600/902335212905824