[GitHub 100日チャレンジ] Day 58 - PR説明文を書く
Pull Requestの説明文に何を書けばよいか、変更内容、理由、確認方法、関連Issueの整理方法を学びます。
[GitHub 100日チャレンジ] Day 58 - PR説明文を書く
PR説明文の役割
Pull Requestの説明文は、レビュアーに変更の意図を伝えるための案内です。差分を読む前に、何をなぜ変えたのか分かるとレビューしやすくなります。
入れるとよい項目
- 変更内容
- 変更理由
- 確認したこと
- 影響範囲
- 関連Issue
テンプレート例
1
2
3
4
5
6
7
8
9
10
11
## What
- Fix README typo
## Why
- Improve documentation clarity
## Check
- Read rendered README
今日のゴール
小さなPRでも、変更内容と確認方法を説明文に書く習慣をつけましょう。
この投稿は投稿者によって CC BY 4.0 の下でライセンスされています。
