Git 中的特性分支工作流程
功能分支工作流¶
这种流行的 git 工作流涉及为每个新功能或修复直接在主存储库中创建新的分支。它通常用于贡献者可以直接将代码推送到存储库的项目中。
这个宝石概述了使用 Git 功能分支工作流设置本地存储库以处理和贡献到 rocky-linux/documentation
项目的过程。
用户 "rockstar" 已将此存储库分叉,我们将使用 https://github.com/rockstar/documentation
作为源。
先决条件¶
- GitHub 帐户和项目的 fork(例如
https://github.com/rockstar/documentation
)。 - 已安装
git
和GitHub CLI (gh)
。
过程¶
- 如果尚未完成,请克隆你的 fork
git clone https://github.com/rockstar/documentation.git
cd documentation
- 添加上游远程
git remote add upstream https://github.com/rocky-linux/documentation.git
- 获取上游更改
git fetch upstream
- 创建新的功能分支
git checkout -b feature-branch-name
进行更改、添加新文件并将它们提交
git add . git commit -m "Implementing feature X"
保持分支更新。定期将上游更改合并进来,以避免冲突
git pull upstream main --rebase
推送到你的 fork,输入
git push origin feature-branch-name
- 创建拉取请求
gh pr create --base main --head rockstar:feature-branch-name --title "New Feature X" --body "Long Description of the feature"
结论¶
功能分支工作流是一种常见的协作技术,它允许团队同时处理项目的各个方面,同时维护稳定的主代码库。
所涉及的主要步骤是
- 克隆主存储库:直接将主项目存储库克隆到你的本地机器。
- 创建功能分支:对于每个新任务,使用描述性名称创建主分支的新分支。
- 提交更改:在你的分支中处理功能或修复,并提交更改。
- 保持分支更新:定期与主分支合并或变基,以了解最新的更改。
- 打开拉取请求:将分支推送到主存储库,并在你的功能准备好后打开拉取请求以供审查。
- 代码审查和合并:在审查和批准后,将分支合并到主分支。
优势:
- 简化了具有直接存储库访问权限的普通贡献者的贡献。
- 确保每个功能在集成到主代码库之前都经过审查。
- 有助于维护干净且线性的项目历史记录。
作者:Wale Soyinka
贡献者:Ganna Zhyrnova