メインコンテンツまでスキップ
に最終更新

プルリクエスト

GitHub には、共同作業に便利な プルリクエスト（PR） の仕組みがあります。この文書では、Apache Doris プロジェクトに PR を提出するまでの一連の手順を説明します。

全体の流れは次のとおりです。

  1. apache/doris リポジトリを自分のアカウントにフォークします。
  2. ローカルの git を設定し、変更をコミットします。
  3. GitHub で PR を作成します。
  4. 競合がある場合は、リベースして解消します。

1. リポジトリをフォークする​

GitHub ページ で apache/doris リポジトリを開き、右上の Fork ボタンをクリックしてフォークします。

フォーク

2. Git を設定して変更をコミットする​

(1) コードをローカルにクローンする​

git clone https://github.com/<your_github_name>/doris.git
cd doris
git submodule update --init --recursive

注: <your_github_name> は自分の GitHub ユーザー名に置き換えてください。

クローンが完了すると、origin はデフォルトで GitHub 上の自分のフォークを指します。

(2) apache/doris を upstream リモートとして追加する​

cd doris
git remote add upstream https://github.com/apache/doris.git

(3) リモートリポジトリの設定を確認する​

git remote -v
origin    https://github.com/<your_github_name>/doris.git (fetch)
origin    https://github.com/<your_github_name>/doris.git (push)
upstream  https://github.com/apache/doris.git (fetch)
upstream  https://github.com/apache/doris.git (push)

(4) 変更用の新しいブランチを作成する​

git checkout -b <your_branch_name>

注: <your_branch_name> は自分で決めたブランチ名です。

ブランチを作成したら、そのブランチでコードを変更できます。

(5) コードをリモートブランチにプッシュする​

git commit -a -m "<your_commit_message>"
git push origin <your_branch_name>

git の使い方について詳しくは、GitHub の公式ドキュメント「Git の使用」を参照してください。

3. PR を作成する​

(1) 新しい PR を開く​

ブラウザーで自分の GitHub ページを開き、プッシュしたブランチ（<your_branch_name>）に切り替えて、Compare & pull request ボタンをクリックして PR を作成します。

新しい PR

(2) ブランチを選択する​

Create pull request ボタンが表示されます。表示されない場合は、ブランチが正しく選択されているか確認してください。compare across forks をクリックして、リポジトリとブランチを選び直すこともできます。

PR の作成

(3) コミットメッセージを入力する​

コミットの概要と詳細を入力し、Create pull request をクリックして作成を完了します。

コミットメッセージを書く際の要点は次のとおりです。

項目要件
表現英語の「動詞 + 目的語」の形で、命令文として書く
時制動詞に過去形を使わない
件名と本文両方が必要で、空行で区切る（GitHub の PR ページでは二つの欄にそれぞれ入力する）
件名の長さ50 文字以内
本文の行幅各行 72 文字以内。超える場合は手動で改行する
本文の内容「何を、なぜ、どのように行ったか」を説明する
件名の最初の文字大文字にする
件名の末尾ピリオドを付けない
関連 Issue本文で関連する Issue を参照する（例: #233）

詳しくは、https://chris.beams.io/posts/git-commit を参照してください。

PR の作成

(4) PR の作成を完了する​

PR を作成すると、Doris プロジェクトのメンテナーによるレビューを待つ状態になります。レビューとマージを待つか、コミュニティに直接連絡して状況を確認できます。

PR の作成

これで PR の作成は完了です。PR について詳しくは、Issue とプルリクエストを使った共同作業 を参照してください。

(5) CI チェックの通過を待つ​

PR を作成すると、CI パイプラインが自動的に起動します。PR ページ下部のチェック一覧では、次の点を確認してください。

  • Required と表示されたチェックは、PR をマージする前にすべて通過（緑色で表示）している必要があります。
  • それ以外の Required ではないチェックは参考情報であり、マージを妨げません。

どのチェックが Required かは、PR ページにその時点で表示される内容で決まります。チェックが失敗した場合は、そのチェックをクリックして GitHub Actions のログを開き、エラーの原因を特定してください。修正後に git push を実行すると、チェックが再度起動します。

4. 競合を解消する​

PR 提出時のコードの競合は、通常、複数の人が同じファイルを編集することで発生します。次の手順で解消します。

(1) メインブランチに切り替える​

git checkout master

(2) リモートのメインブランチをローカルに同期する​

git pull upstream master

(3) 開発ブランチに戻る（ブランチ名を fix とする）​

git checkout fix

(4) リベースを実行する​

git rebase -i master

コミット履歴を示すファイルが開きます。通常は、そのまま保存します。その後、Git が競合しているファイルを示します。競合している各ファイルを開いて競合を解消してください。すべての競合を処理したら、次を実行します。

git add .
git rebase --continue

画面に rebase successful のようなメッセージが表示されるまで繰り返します。その後、更新内容を PR のブランチに強制プッシュします。

git push -f origin fix

5. 一連の操作例​

以下は、コードの同期からブランチのプッシュまでの一連の操作例です。

(1) upstream が設定済みのローカルブランチで最新のコードを取得する​

$ git branch
* master

$ git fetch upstream
remote: Counting objects: 195, done.
remote: Compressing objects: 100% (68/68), done.
remote: Total 141 (delta 75), reused 108 (delta 48)
Receiving objects: 100% (141/141), 58.28 KiB, done.
Resolving deltas: 100% (75/75), completed with 43 local objects.
From https://github.com/apache/doris
   9c36200..0c4edc2  master     -> upstream/master

(2) リベースを実行する​

$ git rebase upstream/master
First, rewinding head to replay your work on top of it...
Fast-forwarded master to upstream/master.

(3) 他の人のコミットが自分のリポジトリにまだ同期されていないか確認する​

$ git status
# On branch master
# Your branch is ahead of 'origin/master' by 8 commits.
#
# Untracked files:
#   (use "git add <file>..." to include in what will be committed)
#
#       custom_env.sh
nothing added to commit but untracked files present (use "git add" to track)

(4) 他の人のコミットを自分のリポジトリに同期する​

$ git push origin master
Counting objects: 195, done.
Delta compression using up to 32 threads.
Compressing objects: 100% (41/41), done.
Writing objects: 100% (141/141), 56.66 KiB, done.
Total 141 (delta 76), reused 140 (delta 75)
remote: Resolving deltas: 100% (76/76), completed with 44 local objects.
To https://lide-reed:xxxx@github.com/lide-reed/doris.git
   9c36200..0c4edc2  master -> master

(5) 新しいブランチを作成して開発を始める​

$ git checkout -b my_branch
Switched to a new branch 'my_branch'

$ git branch
  master
* my_branch

(6) コードを編集した後、変更をステージングする​

$ git add -u

(7) メッセージを入力してローカルブランチにコミットする​

$ git commit -m "Fix a typo"
[my_branch 55e0ba2] Fix a typo
 1 files changed, 2 insertions(+), 2 deletions(-)

(8) ブランチを GitHub 上の自分のリポジトリにプッシュする​

$ git push origin my_branch
Counting objects: 11, done.
Delta compression using up to 32 threads.
Compressing objects: 100% (6/6), done.
Writing objects: 100% (6/6), 534 bytes, done.
Total 6 (delta 4), reused 0 (delta 0)
remote: Resolving deltas: 100% (4/4), completed with 4 local objects.
remote:
remote: Create a pull request for 'my_branch' on GitHub by visiting:
remote:      https://github.com/lide-reed/doris/pull/new/my_branch
remote:
To https://lide-reed:xxxx@github.com/lide-reed/doris.git
 * [new branch]      my_branch -> my_branch

これで、上記の手順に従って PR を作成できます。

Report issue
On This Page