読み方のヒント

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

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

2.2 プルリクエストの説明

プルリクエストの説明には、読む人が確かめるために必要なことを書きます。リポジトリに型(テンプレート)を置くと、書きもらしが減ります。

<!-- .github/pull_request_template.md -->
## 目的
<!-- 何のための変更か。関係する頼みごとや課題 -->

## 変更の内容
<!-- 主な変更を3〜5行で -->

## 確かめたこと
- [ ] npm run lint / typecheck / test:run が通る
- [ ] 画面で動きを確かめた(確かめた手順を書く)
- [ ] キーボードで操作できる
- [ ] 画面の写真(見た目が変わる場合)

## 読む人に見てほしいところ
<!-- 迷ったところ、自信のないところ -->
項目読む人にとっての役割
目的変更が目的に合っているかを判断できる
確かめたことどこまで確かめてあるかが分かり、重ねて確かめずに済む
見てほしいところ時間をかけて読む場所が分かる
解答の例

1行目は「商品のページの写真を next/image に置きかえる」。本文に「スマートフォンで写真の表示が遅かったため。Lighthouse のモバイルで LCP が 3.9秒から 2.1秒になった。」と書きます。

8 / 17