|
| 1 | +<!-- これはコメントです。ブラウザで表示されません。 --> |
| 2 | +<!-- Preview のシートに切り替えることで登録後にどのように見えるか確認することができます --> |
| 3 | + |
| 4 | +# PR の目的 |
| 5 | + |
| 6 | +<!-- PR の目的を記載してください --> |
| 7 | +<!-- ～をすることによって、～を実現する ということがわかる ことが必要 (この PR で何を実現したいか) --> |
| 8 | +<!-- これが共有されていないとレビューアーがそれを問い合わせる必要があり、PR がマージされるのに時間がかかってきたからです。 --> |
| 9 | +<!-- 状況によって記載内容を端折ってもいいが、意図的に端折る意識が必要 (単なるスペルミスの修正なら別に目的は不要など) --> |
| 10 | +<!-- --> |
| 11 | +<!-- 目的あるいは手段が大きく変わった時には PR を再利用しようと考えず、新たな PR を作成するようにしてください。 --> |
| 12 | +<!-- 1. これまでの作業内容を別ブランチに push すれば多くの場合、一部を再利用できます。 --> |
| 13 | +<!-- 2. これまでの経緯を知らない人でもレビューに参加しやすくなります。 --> |
| 14 | +<!-- 3. 新たな PR 作成時にまとめを書くことで PR 作成者の頭の整理ができます。 --> |
| 15 | +<!-- 4. PR マージ後に見るときに関係していない人が理解しやすくなります。 --> |
| 16 | +<!-- 必須 --> |
| 17 | + |
| 18 | +## カテゴリ |
| 19 | + |
| 20 | +<!-- 編集 必須 --> |
| 21 | +<!-- 以下の箇条書きリストから関係するものを残して、関係ないものを削除してください。--> |
| 22 | +<!-- 該当するものがない場合は必要に応じて追加してください。 --> |
| 23 | + |
| 24 | +- 機能追加 |
| 25 | +- 仕様変更 |
| 26 | +- 不具合修正 |
| 27 | +- 速度向上 |
| 28 | +- リファクタリング |
| 29 | +- ドキュメント修正 |
| 30 | +- ビルド手順 |
| 31 | +- CI関連 |
| 32 | + - Appveyor |
| 33 | + - Azure Pipelines |
| 34 | + - その他連携サービス |
| 35 | +- 実験 (master へのマージを目的としない) |
| 36 | +- その他 |
| 37 | + |
| 38 | +## PR の背景 |
| 39 | + |
| 40 | +<!-- PR を行う背景を記載してください --> |
| 41 | +<!-- 自明な場合は省略してもいいですが、可能なら記載してほしいです。 --> |
| 42 | +<!-- 好みの問題に属する部分に関しては、どちらが正しいということはないので好みの問題かもしれないと明示すること。 --> |
| 43 | +<!-- 明示することによって PR を受け入れられやすくなるし、どちらが正しいかという議論が延々続くのを回避できる。 --> |
| 44 | + |
| 45 | +## PR のメリット |
| 46 | + |
| 47 | +<!-- PR のメリットを記載してください。 --> |
| 48 | +<!-- 自明な場合は省略してもいいですが、可能なら記載してほしいです。 --> |
| 49 | + |
| 50 | +## PR のデメリット (トレードオフとかあれば) |
| 51 | + |
| 52 | +<!-- PR のデメリットやトレードオフ等あれば記載してください。 --> |
| 53 | + |
| 54 | +## PR の影響範囲 |
| 55 | + |
| 56 | +<!-- 既存の処理に対して影響範囲を記載してください。 --> |
| 57 | +<!-- 自明な場合は省略してもいいですが、可能なら記載してほしいです。 --> |
| 58 | + |
| 59 | +## 関連チケット |
| 60 | + |
| 61 | +<!-- 関連するチケットの情報を記載してください。 --> |
| 62 | +<!-- #xxx と書くと チケット xxx に対して自動的にリンクが張られます。 --> |
| 63 | +<!-- close #xxx と書くと PR がマージされたときに自動的にチケット xxx がクローズされます。 --> |
| 64 | +<!-- close だけでなく他のキーワードでも OK です。↓ に説明があります。--> |
| 65 | +<!-- https://help.github.com/en/articles/closing-issues-using-keywords--> |
| 66 | + |
| 67 | +## 参考資料 |
| 68 | + |
| 69 | +<!-- 参考になる資料の URL 等あればここに記載御願いします --> |
| 70 | +<!-- 説明に必要なスクリーンショットがあれば貼り付けお願いします。--> |
| 71 | +<!-- 画像ファイルをこの欄にドラッグ＆ドロップすれば画像が貼り付けられます --> |
0 commit comments