Project

General

Profile

Pull Request Policy (ja) » History » Version 3

Youichi Kimura, 2016-08-09 15:01

1 1 kaoru n
h1. プルリクエストにおけるポリシー
2 1 kaoru n
3 1 kaoru n
h3. プルリクエストに含まれるソースコードについて
4 1 kaoru n
5 1 kaoru n
対応チケットへの変更分のみを含んでください。
6 1 kaoru n
以下のコミットメッセージのルール、OpenPNE3 PHP 標準コーディング規約、OpenPNE3 セキュアコーディングガイドラインにも準拠してください。
7 1 kaoru n
* "コミットメッセージのルール":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
8 1 kaoru n
* "OpenPNE3 PHP 標準コーディング規約":http://www.openpne.jp/coding-standards-ja/
9 1 kaoru n
* "OpenPNE3 セキュアコーディングガイドライン":http://www.openpne.jp/developer/secure-coding-guideline/
10 1 kaoru n
11 1 kaoru n
また、必須ではありませんが、テストコードが含まれていて実際に動作しテストが成功するコードであることを目指してください。
12 1 kaoru n
13 1 kaoru n
h3. プルリクエストのbaseとして指定するブランチ
14 1 kaoru n
15 1 kaoru n
<pre>
16 1 kaoru n
https://github.com/openpne/OpenPNE3/tree/master
17 1 kaoru n
</pre>
18 1 kaoru n
19 1 kaoru n
h3. プルリクエストのcompareとして指定するブランチ
20 1 kaoru n
21 1 kaoru n
開発者のリポジトリの作業用のブランチを指定してください。
22 1 kaoru n
23 2 Youichi Kimura
h3. プルリクエストの Milestone に指定するマイルストーン
24 2 Youichi Kimura
25 2 Youichi Kimura
!{width:354px}pr-set-milestone.png(Pull Request の作成画面で Set milestone のメニューを開いた状態のキャプチャ。master, stable-3.6.x, stable-3.8.x が選択可能な状態になっている)!
26 2 Youichi Kimura
27 2 Youichi Kimura
Pull Request の作成時(作成後でも可)に、上図のように Milestone をセットすることができます。 Pull Request のマージ先 (base に指定したブランチ) と同じ名前の Milestone を選択して下さい。
28 2 Youichi Kimura
29 2 Youichi Kimura
Pull Request に Milestone がセットされていない状態でもチケットのワークフロー自体には支障はありませんが、Milestone がセットされていないと Pull Request がそれぞれどのバージョンを対象としたものか確認するためには個々の Pull Request のページを参照しなければならないため、なるべく適切な Milestone がセットされた状態にして下さい。
30 2 Youichi Kimura
31 3 Youichi Kimura
@openpne/OpenPNE3@ の Milestone 一覧: https://github.com/openpne/OpenPNE3/milestones
32 3 Youichi Kimura
33 1 kaoru n
h3. プルリクエスト方法
34 1 kaoru n
35 1 kaoru n
https://github.com/openpne/OpenPNE3/pulls
36 1 kaoru n
上記URLより「New pull request」ボタンを押下して、プルリクエストを行ってください。
37 1 kaoru n
タイトルは下記の例のように、Redmine 側のチケットのタイトルと合わせ、チケットの番号を含めてください。
38 1 kaoru n
例)Bugチケットの場合: 
39 1 kaoru n
<pre>
40 1 kaoru n
(refs #3560) スマートフォンで画像をアップロードすると画像が横向きになってしまう場合がある
41 1 kaoru n
</pre>
42 1 kaoru n
例)Backportチケットの場合: 
43 1 kaoru n
<pre>
44 1 kaoru n
(refs #3562 BP from #3560) スマートフォンで画像をアップロードすると画像が横向きになってしまう場合がある
45 1 kaoru n
</pre>
46 1 kaoru n
もし、Redmineにまだチケットが作成されていない場合は、新規に作成してください。
47 1 kaoru n
チケットを発行する場合は、 "How To Report Issue (ja)":https://redmine.openpne.jp/projects/op3/wiki/How_To_Report_Issue_%28ja%29 を参照してください。
48 1 kaoru n
githubでのプルリクエスト方法については、"こちら":https://help.github.com/articles/creating-a-pull-request を参照してください。
49 1 kaoru n
50 1 kaoru n
h3. チケットでの報告
51 1 kaoru n
52 1 kaoru n
プルリクエスト後、チケットのコメントにプルリクエストのURLを記入し投稿してください。
53 1 kaoru n
54 1 kaoru n
h3. コードレビュー・テストでのフィードバックへの対応
55 1 kaoru n
56 1 kaoru n
コードレビューまたはテストでのフィードバックは、チケットを通して行われます。
57 1 kaoru n
※プルリクエストのソースに直接コメントが有る場合は、チケットにもその旨が記入されます。
58 1 kaoru n
開発者はフィードバックに対応後、チケットのステータスを「Pending Review(レビュー待ち)」に変更してください。