GitHubのわかりやすいプルリクエストの書き方
GitHubをレビューをしてもらうときにやはり他の方が確認をするため、見やすくする必要がありますよね。なので今回はそのGitHubのわかりやすいプルリクエストの書き方をご紹介します^_^
記述の仕方を工夫する
わたしが着目したのは以下の項目になります。
- タイトルを見やすくする
- Issueの番号を記載する
- 変更内容をタスクリストでわかりやすく記述する
- 期待できる結果を記述する
このように見やすくすることで一見してコードレビューしてもらいやすくするための工夫を行いました。ちなみにこちらは全て手書きでプレビューした見た目になります。書いた内容はこちらになります！
そして編集終了後の画面がこちらになります！
今回はGitHubのわかりやすいプルリクエストの内容でしたがぜひご参考になれましたら幸いです^_^