GitHubへpull requestする際のお作法

GoProjectというレポジトリをベースにWeb連珠盤(Web Renju Board)を開発した際にいくつかバグを見つけました。その修正パッチをpull requestする際の手順についてまとめました。

Issueをあげる

必須ではないですが、できればIssueをあげて問題点を明記しましょう。

自レポジトリへの取り込み

修正したいレポジトリをforkし自レポジトリに取り込みましょう。取り込み対象のレポジトリ画面の右上に「Fork」というボタンがあるのでクリックすることで取り込めます。

修正作業

まずforkして取り込んだプロジェクトのcloneを作成します。

$ git clone https://github.com/starpentagon/GoProject.git

プロジェクトディレクトリに移り修正用のブランチを切ります。masterブランチはfork元の変更を追随するために使うため別ブランチを切るのがお作法です。ここでは、STPropertyBugSpikeというブランチを切っています。Issueと合わせた名前にしておくと分かりやすいと思います。

$ cd GoProject.git
$ git checkout -b STPropertyBugSpike

作成したブランチで修正作業を行います。修正作業が終わったらcommit/pushしましょう。

$ git commit
$ git push origin STPropertyBugSpike

必要に応じてfork元の更新への追随や過去のcommitを1つにまとめるようにします。

pull requestの作成

STPropertyBugSpikeブランチからpull requestを作成しましょう。事象とその発生理由、修正案を記載します。

pull requestを作成し、fork元のレポジトリにpull requestが登録されていれば完了です。

参考情報

スポンサーリンク







シェアする

  • このエントリーをはてなブックマークに追加

フォローする

スポンサーリンク