GitHubのPRテンプレートについて

GitHubでPR作成時のDescriptionエリアに初期表示させるテンプレートのことです。
初期表示される内容は .github/PULL_REQUEST_TEMPLATE.md 内に記載した内容は反映されます。

▼ デモ動画

▼ 画像が荒いので静止画ver

なぜPRのDescriptionを書くのか

• 何をしたいPRなのかをレビュワーに伝えれるようにする。。
• 未来の誰かがPRを見返す時に当時の状況がわかるようにする。
• 自分でチェックできる項目をしっかりと確認することを強制する。

ファイルの配置場所

リポジトリ直下 もしくは .githubフォルダー 内に PULL_REQUEST_TEMPLATE.md がついたファイルを配置することで、PRを作成した際に、自動でテキストが挿入されます.

.
├- .github
|    |
|    └- PULL_REQUEST_TEMPLATE.md 
|
:

利用してほしいPRテンプレート

このテンプレートは盲信しすぎず、不要だと思った項目は各プロジェクトにて削除してください。

ディレクトリ名/ファイル名は必ず .github/PULL_REQUEST_TEMPLATE.md である必要があります。 .github/PULL_REQUEST_TEMPLATE_XXX.md とした場合はうまく動作しないので、必ず _XXX の部分は削除するようにしてください。

• 🔰 シンプルver
• React ver
• Unity ver