3.4 KiB
3.4 KiB
新需求开发流程
本文档旨在提供一个标准、安全的新功能开发工作流,涵盖从创建功能分支到最终合并回主开发分支的完整步骤。
核心流程
采用功能分支(Feature Branch)的工作模式,主要步骤如下:
- 同步与切换:将远程创建的新功能分支(如
lyf-dev-req0001
)同步到本地并切换。 - 开发与提交:在本地功能分支上进行开发,并频繁提交改动。
- 推送与备份:将本地的改动推送到远程功能分支。
- 合并回主线:当功能开发测试完成后,将其合并回主开发分支(如
lyf-dev
)。 - 清理分支:合并完成后,清理已完成使命的功能分支。
详细命令使用步骤
步骤一:同步远程分支到本地
假设您的同事已经在远程仓库基于 lyf-dev
创建了 lyf-dev-req0001
分支。
-
获取远程所有最新信息: 这个命令会把远程仓库的新分支信息下载到你的本地,但不会做任何修改。
git fetch origin
-
创建并切换到本地功能分支: 这个命令会在本地创建一个名为
lyf-dev-req0001
的新分支,并自动设置它跟踪远程的origin/lyf-dev-req0001
分支。git checkout lyf-dev-req0001
现在,您已经处于一个干净、独立的功能分支上,可以开始开发了。
步骤二:在功能分支上开发
在这个分支上进行的所有修改都与 lyf-dev
无关,可以放心操作。
-
修改代码:根据需求添加、修改文件。
-
提交改动: 建议小步快跑,完成一个小的功能点就提交一次。
# 将所有修改添加到暂存区 git add . # 提交并撰写清晰的说明 git commit -m "feat: 完成用户登录接口"
-
推送到远程功能分支: 为了备份代码或与他人协作,需要将本地的提交推送到远程。
git push origin lyf-dev-req0001
步骤三:合并功能到主开发分支 (lyf-dev
)
当新功能开发完成,并且经过充分测试后,执行以下步骤将其合并回 lyf-dev
。
-
切换回主开发分支:
git checkout lyf-dev
-
确保
lyf-dev
是最新的: 在合并前,务必先从远程拉取lyf-dev
的最新代码,以防他人在此期间有更新。git pull origin lyf-dev
-
合并功能分支: 这是最关键的一步,将
lyf-dev-req0001
的所有新功能合并进来。git merge lyf-dev-req0001
- 无冲突:Git 会自动完成合并。
- 有冲突 (Conflict):Git 会提示你哪些文件冲突了。你需要手动解决这些文件中的冲突,然后执行
git add .
和git commit
来完成合并。
-
推送合并后的
lyf-dev
: 将本地合并好的lyf-dev
分支推送到远程仓库。git push origin lyf-dev
步骤四:清理分支(可选)
合并完成后,功能分支的历史使命就完成了。为了保持仓库的整洁,可以删除它。
-
删除远程分支:
git push origin --delete lyf-dev-req0001
-
删除本地分支:
git branch -d lyf-dev-req0001
遵循以上流程,可以确保您的开发工作流清晰、安全且高效。