StarRocks GitHub 工作流程

StarRocks GitHub 工作流程

StarRocks项目遵循GitHub工作流规范，其中包含若干实用建议（例如保持本地环境与上游仓库同步并及时提交）。本文档详细说明在GitHub平台完成StarRocks开发的完整工作流程。

第一步：云端分叉项目

访问：https://github.com/StarRocks/starrocks
点击右上角"Fork"按钮创建云端代码库分支

第二步：克隆分支至本地

• 点击Code > Clone获取仓库地址

$ cd $working_dir  
$ git clone https://github.com/$user/starrocks

• 添加上游仓库关联

$ cd $working_dir/starrocks
$ git remote add upstream https://github.com/StarRocks/starrocks.git

• 使用以下命令验证远程仓库配置：

origin    https://github.com/$user/starrocks.git (fetch)
origin    https://github.com/$user/starrocks.git (push)
upstream  https://github.com/StarRocks/starrocks (fetch)
upstream  https://github.com/StarRocks/starrocks (push)

第三步：同步分支

• 确保本地分支与远程内容一致

$ cd $working_dir/starrocks
$ git checkout main
$ git fetch main
$ git rebase upstream/main
$ git push origin main 

第四步：创建开发分支

• 基于主分支创建新分支

$ git checkout -b myfeature

第五步：配置开发环境

• 配置前端(FE)开发环境
• 配置后端(BE)开发环境

第六步：修改内容或代码

• 在新创建的分支中进行内容或代码修改

第七步：提交更改

• 提交修改内容

$ git add <文件名>
$ git commit -m "提交说明"

• 如需多次修改提交，可参考以下命令

$ git add <文件名>          # 添加单个文件
$ git add -A               # 添加所有变更（新增/删除/修改）
$ git add -a -m "提交说明"  # 添加并提交修改和删除的文件
$ git add -u               # 添加修改和删除文件（不含新增）
$ git add .                # 添加新增和修改文件（不含删除）

第八步：推送更改

• 将变更推送到分叉仓库的远程分支

$ git push origin myfeature

第九步：发起拉取请求(PR)

• 访问您的分叉仓库 https://github.com/$user/starrocks
• 点击"Compare & pull request"按钮

第十步：评审与合并

PR提交后需经过至少2位评审人员确认，由StarRocks维护者在最终修改通过后完成合并

第十一步：等待CI验证

PR提交后将自动触发CI流程，必须通过所有必需检查项。若检查未通过，可点击"Details"链接查看详细信息

来自官网翻译：https://github.com/StarRocks/community/blob/main/Contributors/guide/workflow.md