Pull Request 概要欄に記載する内容に意識して欲しいこと・守ってほしいこと

はじめに

Pull Request（以下※PR）のルールではなく「PRの概要欄」の話。現状以下だけでレビュアーとして助かっている。

守ってほしいこと

1. ソースコードのスクリーンショットは利用しないでください。
   1. ソースコードを共有したい場合は、GitHub 上のソースコードの行リンクを選択し右クリックしURLを貼り付けてください。
2. PR概要欄にファイル名や関連ファイルのフルパスを記載する場合は、ファイル名の文字を記載するのではなくGitHub上の該当のファイルのリンクURLを貼り付けてください。
3. PR概要欄の上部には課題（タスク）のURLを貼り付けてください。
4. 課題（タスク）に関係がない修正をPRに含めないでください。
   1. もし含める場合は、必ずPR概要欄に説明を入れてください。

意識してほしいこと

1. 課題URLだけではなく、可能であれば「どのような対応をしたのか」を簡単に記載してください。
   1. 影響範囲が大きいPRであれば、影響範囲についても言及してください。
   2. ※「誤字を訂正するのみ」等の明らかにすぐ理解できる内容であれば不要です。
2. PR内容にはできる限り修正箇所がわかるようなスクリーンショット（キャプチャ）を貼り付けてください。
   1. 貼り付けた写真が「修正前」なのか「修正後」なのか分かるようにしてください。
   2. ※「誤字を訂正するのみ」等の明らかにすぐ理解できる内容であれば不要です。

特に後者は、サービスリリース後（運用中）の場合、特に意識してほしい内容です。