Pull Request Policy (ja) » 履歴 » バージョン 3
バージョン 2 (Youichi Kimura, 2016-08-09 15:00) → バージョン 3/4 (Youichi Kimura, 2016-08-09 15:01)
h1. プルリクエストにおけるポリシー
h3. プルリクエストに含まれるソースコードについて
対応チケットへの変更分のみを含んでください。
以下のコミットメッセージのルール、OpenPNE3 PHP 標準コーディング規約、OpenPNE3 セキュアコーディングガイドラインにも準拠してください。
* "コミットメッセージのルール":https://redmine.openpne.jp/projects/op3/wiki/Rule_of_Shared_Repository_%28ja%29#%E3%82%B3%E3%83%9F%E3%83%83%E3%83%88%E3%83%A1%E3%83%83%E3%82%BB%E3%83%BC%E3%82%B8
* "OpenPNE3 PHP 標準コーディング規約":http://www.openpne.jp/coding-standards-ja/
* "OpenPNE3 セキュアコーディングガイドライン":http://www.openpne.jp/developer/secure-coding-guideline/
また、必須ではありませんが、テストコードが含まれていて実際に動作しテストが成功するコードであることを目指してください。
h3. プルリクエストのbaseとして指定するブランチ
<pre>
https://github.com/openpne/OpenPNE3/tree/master
</pre>
h3. プルリクエストのcompareとして指定するブランチ
開発者のリポジトリの作業用のブランチを指定してください。
h3. プルリクエストの Milestone に指定するマイルストーン
!{width:354px}pr-set-milestone.png(Pull Request の作成画面で Set milestone のメニューを開いた状態のキャプチャ。master, stable-3.6.x, stable-3.8.x が選択可能な状態になっている)!
Pull Request の作成時（作成後でも可）に、上図のように Milestone をセットすることができます。 Pull Request のマージ先 (base に指定したブランチ) と同じ名前の Milestone を選択して下さい。
Pull Request に Milestone がセットされていない状態でもチケットのワークフロー自体には支障はありませんが、Milestone がセットされていないと Pull Request がそれぞれどのバージョンを対象としたものか確認するためには個々の Pull Request のページを参照しなければならないため、なるべく適切な Milestone がセットされた状態にして下さい。
@openpne/OpenPNE3@ の Milestone 一覧: https://github.com/openpne/OpenPNE3/milestones
h3. プルリクエスト方法
https://github.com/openpne/OpenPNE3/pulls
上記URLより「New pull request」ボタンを押下して、プルリクエストを行ってください。
タイトルは下記の例のように、Redmine 側のチケットのタイトルと合わせ、チケットの番号を含めてください。
例）Bugチケットの場合:
<pre>
(refs #3560) スマートフォンで画像をアップロードすると画像が横向きになってしまう場合がある
</pre>
例）Backportチケットの場合:
<pre>
(refs #3562 BP from #3560) スマートフォンで画像をアップロードすると画像が横向きになってしまう場合がある
</pre>
もし、Redmineにまだチケットが作成されていない場合は、新規に作成してください。
チケットを発行する場合は、 "How To Report Issue (ja)":https://redmine.openpne.jp/projects/op3/wiki/How_To_Report_Issue_%28ja%29 を参照してください。
githubでのプルリクエスト方法については、"こちら":https://help.github.com/articles/creating-a-pull-request を参照してください。
h3. チケットでの報告
プルリクエスト後、チケットのコメントにプルリクエストのURLを記入し投稿してください。
h3. コードレビュー・テストでのフィードバックへの対応
コードレビューまたはテストでのフィードバックは、チケットを通して行われます。
※プルリクエストのソースに直接コメントが有る場合は、チケットにもその旨が記入されます。
開発者はフィードバックに対応後、チケットのステータスを「Pending Review（レビュー待ち）」に変更してください。
h3. プルリクエストに含まれるソースコードについて
対応チケットへの変更分のみを含んでください。
以下のコミットメッセージのルール、OpenPNE3 PHP 標準コーディング規約、OpenPNE3 セキュアコーディングガイドラインにも準拠してください。
* "コミットメッセージのルール":https://redmine.openpne.jp/projects/op3/wiki/Rule_of_Shared_Repository_%28ja%29#%E3%82%B3%E3%83%9F%E3%83%83%E3%83%88%E3%83%A1%E3%83%83%E3%82%BB%E3%83%BC%E3%82%B8
* "OpenPNE3 PHP 標準コーディング規約":http://www.openpne.jp/coding-standards-ja/
* "OpenPNE3 セキュアコーディングガイドライン":http://www.openpne.jp/developer/secure-coding-guideline/
また、必須ではありませんが、テストコードが含まれていて実際に動作しテストが成功するコードであることを目指してください。
h3. プルリクエストのbaseとして指定するブランチ
<pre>
https://github.com/openpne/OpenPNE3/tree/master
</pre>
h3. プルリクエストのcompareとして指定するブランチ
開発者のリポジトリの作業用のブランチを指定してください。
h3. プルリクエストの Milestone に指定するマイルストーン
!{width:354px}pr-set-milestone.png(Pull Request の作成画面で Set milestone のメニューを開いた状態のキャプチャ。master, stable-3.6.x, stable-3.8.x が選択可能な状態になっている)!
Pull Request の作成時（作成後でも可）に、上図のように Milestone をセットすることができます。 Pull Request のマージ先 (base に指定したブランチ) と同じ名前の Milestone を選択して下さい。
Pull Request に Milestone がセットされていない状態でもチケットのワークフロー自体には支障はありませんが、Milestone がセットされていないと Pull Request がそれぞれどのバージョンを対象としたものか確認するためには個々の Pull Request のページを参照しなければならないため、なるべく適切な Milestone がセットされた状態にして下さい。
@openpne/OpenPNE3@ の Milestone 一覧: https://github.com/openpne/OpenPNE3/milestones
h3. プルリクエスト方法
https://github.com/openpne/OpenPNE3/pulls
上記URLより「New pull request」ボタンを押下して、プルリクエストを行ってください。
タイトルは下記の例のように、Redmine 側のチケットのタイトルと合わせ、チケットの番号を含めてください。
例）Bugチケットの場合:
<pre>
(refs #3560) スマートフォンで画像をアップロードすると画像が横向きになってしまう場合がある
</pre>
例）Backportチケットの場合:
<pre>
(refs #3562 BP from #3560) スマートフォンで画像をアップロードすると画像が横向きになってしまう場合がある
</pre>
もし、Redmineにまだチケットが作成されていない場合は、新規に作成してください。
チケットを発行する場合は、 "How To Report Issue (ja)":https://redmine.openpne.jp/projects/op3/wiki/How_To_Report_Issue_%28ja%29 を参照してください。
githubでのプルリクエスト方法については、"こちら":https://help.github.com/articles/creating-a-pull-request を参照してください。
h3. チケットでの報告
プルリクエスト後、チケットのコメントにプルリクエストのURLを記入し投稿してください。
h3. コードレビュー・テストでのフィードバックへの対応
コードレビューまたはテストでのフィードバックは、チケットを通して行われます。
※プルリクエストのソースに直接コメントが有る場合は、チケットにもその旨が記入されます。
開発者はフィードバックに対応後、チケットのステータスを「Pending Review（レビュー待ち）」に変更してください。