読み方のヒント

矢印ボタン(または ← → キー)でページを移動できます。

第2節 コミットとプルリクエストの書き方

2.1 コミットの書き方

コミットの1行目には、何を変えたかを短く書きます。

予約のキャンセルに理由を書けるようにする

店の人が、キャンセルの理由(お客さんの連絡、店の都合)を
あとから確かめられるようにするため。

- Reservation の cancelled に reason を足す
- キャンセルのダイアログに、理由の選択肢を足す
部分書くこと
1行目何を変えたか(50文字程度まで)
2行目空ける
3行目からなぜ変えたか、気をつけること
よくない例何が困るかよい例
「修正」何を直したか分からない「在庫の表示で画面がずれるのを直す」
「いろいろ変更」目的が分からず、取り消しにくい目的ごとにコミットを分ける
何をしたかだけなぜ変えたかが残らない理由を本文に書く

チームによっては、feat:・fix: のような接頭語を付ける決まり(Conventional Commits)を使います。どちらにするかは、チームで1つに決めます。

7 / 17