跳到主要内容

提交代码指南

1. Fork 仓库​

AREX 目前核心服务组件包括 AREX-Agent、AREX-API、AREX-Storage、AREX-Schedule、AREX-Front，首先确定需要提交代码的仓库，从远端仓库 https://github.com/arextest/<服务组件仓库>.git Fork 一份代码到自己的仓库中。以下以 AREX-Storage 仓库为例说明。

2. 配置 git 和提交修改​

  • 把自己 Fork 的仓库 clone 到本地。
git clone https://github.com/<your_github_name>/arex-storage.git
  • 添加远端仓库地址，命名为 upstream，例如：
git remote add upstream https://github.com/arextest/arex-storage.git
  • 查看仓库：
git remote -v

此时会有两个仓库：origin（自己的仓库）和 upstream（远端仓库）

  • 获取/更新远端仓库代码（如果已经是最新代码，就跳过）：
git fetch upstream
  • 同步远端仓库代码到本地仓库：
git checkout origin/main
git merge --no-ff upstream/main
  • 新建分支：

每次要提交 PR 的时候都要新建一个分支，用于开发 Feature 或者 Bugfix，分支基于 upstream 的 main 建立。

git checkout -b xxx origin/main
  • 在新建的分支上进行代码修改后，提交到自己仓库：
git commit -m 'commit content'
git push origin xxx --set-upstream

3. 创建 PR​

  • 代码提交后，在浏览器打开 Github 的 Pull Request 页面，点击 "New pull request"

  • 选择修改完的本地分支和要合并的目的分支，点击 "Create pull request" 创建 PR。

维护者完成 CodeReview 后，会将提交合并到 main 分支。