From cc30295f1db5acadca163c777c9fce6637b892f9 Mon Sep 17 00:00:00 2001 From: LYFxiaoan Date: Tue, 15 Jul 2025 12:00:59 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=8A=9F=E8=83=BD=E5=BC=80=E5=8F=91?= =?UTF-8?q?=E6=B5=81=E7=A8=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 新需求开发流程.md | 101 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 新需求开发流程.md diff --git a/新需求开发流程.md b/新需求开发流程.md new file mode 100644 index 0000000..818f43a --- /dev/null +++ b/新需求开发流程.md @@ -0,0 +1,101 @@ +# 新需求开发流程 + +本文档旨在提供一个标准、安全的新功能开发工作流,涵盖从创建功能分支到最终合并回主开发分支的完整步骤。 + +## 核心流程 + +采用功能分支(Feature Branch)的工作模式,主要步骤如下: + +1. **同步与切换**:将远程创建的新功能分支(如 `lyf-dev-req0001`)同步到本地并切换。 +2. **开发与提交**:在本地功能分支上进行开发,并频繁提交改动。 +3. **推送与备份**:将本地的改动推送到远程功能分支。 +4. **合并回主线**:当功能开发测试完成后,将其合并回主开发分支(如 `lyf-dev`)。 +5. **清理分支**:合并完成后,清理已完成使命的功能分支。 + +--- + +## 详细命令使用步骤 + +### 步骤一:同步远程分支到本地 + +假设您的同事已经在远程仓库基于 `lyf-dev` 创建了 `lyf-dev-req0001` 分支。 + +1. **获取远程所有最新信息**: + 这个命令会把远程仓库的新分支信息下载到你的本地,但不会做任何修改。 + ```bash + git fetch origin + ``` + +2. **创建并切换到本地功能分支**: + 这个命令会在本地创建一个名为 `lyf-dev-req0001` 的新分支,并自动设置它跟踪远程的 `origin/lyf-dev-req0001` 分支。 + ```bash + git checkout lyf-dev-req0001 + ``` + 现在,您已经处于一个干净、独立的功能分支上,可以开始开发了。 + +### 步骤二:在功能分支上开发 + +在这个分支上进行的所有修改都与 `lyf-dev` 无关,可以放心操作。 + +1. **修改代码**:根据需求添加、修改文件。 + +2. **提交改动**: + 建议小步快跑,完成一个小的功能点就提交一次。 + ```bash + # 将所有修改添加到暂存区 + git add . + + # 提交并撰写清晰的说明 + git commit -m "feat: 完成用户登录接口" + ``` + +3. **推送到远程功能分支**: + 为了备份代码或与他人协作,需要将本地的提交推送到远程。 + ```bash + git push origin lyf-dev-req0001 + ``` + +### 步骤三:合并功能到主开发分支 (`lyf-dev`) + +当新功能开发完成,并且经过充分测试后,执行以下步骤将其合并回 `lyf-dev`。 + +1. **切换回主开发分支**: + ```bash + git checkout lyf-dev + ``` + +2. **确保 `lyf-dev` 是最新的**: + 在合并前,务必先从远程拉取 `lyf-dev` 的最新代码,以防他人在此期间有更新。 + ```bash + git pull origin lyf-dev + ``` + +3. **合并功能分支**: + 这是最关键的一步,将 `lyf-dev-req0001` 的所有新功能合并进来。 + ```bash + git merge lyf-dev-req0001 + ``` + - **无冲突**:Git 会自动完成合并。 + - **有冲突 (Conflict)**:Git 会提示你哪些文件冲突了。你需要手动解决这些文件中的冲突,然后执行 `git add .` 和 `git commit` 来完成合并。 + +4. **推送合并后的 `lyf-dev`**: + 将本地合并好的 `lyf-dev` 分支推送到远程仓库。 + ```bash + git push origin lyf-dev + ``` + +### 步骤四:清理分支(可选) + +合并完成后,功能分支的历史使命就完成了。为了保持仓库的整洁,可以删除它。 + +1. **删除远程分支**: + ```bash + git push origin --delete lyf-dev-req0001 + ``` + +2. **删除本地分支**: + ```bash + git branch -d lyf-dev-req0001 + ``` + +遵循以上流程,可以确保您的开发工作流清晰、安全且高效。 \ No newline at end of file