メインコンテンツまでスキップ

PRの説明とレビューを書く

PR(Pull Request)は変更を提案し、レビューで議論する場所です。メールのレビュー依頼とは分けて、何を変えたか・なぜか・どう確かめたかを残します。以下は架空の変更についての例文です。

タイトルと説明:目的・範囲・検証を揃える​

タイトルはFix empty-state rendering in the search panelのように、対象と変更内容を短く示します。本文では、対象外の変更や未検証の内容も明記します。

## Summary
Show an empty-state message when a search returns no results.

## Why
The panel currently appears blank, so users cannot tell whether the search has finished.

## Scope
This change updates the search panel only. The search API is unchanged.

## Validation
- Added a component test for an empty result.
- Manually checked loading, empty, and error states in desktop Chrome.
- Mobile Safari has not been tested.

## Review focus
Please check the state transitions and the message wording.

日本語の意味: 検索結果が0件のときに空状態のメッセージを表示する変更です。現在は画面が空白で、検索が終了したかがわかりません。対象は検索パネルだけで、APIは変更していません。コンポーネントテストを追加し、デスクトップのChromeで読み込み中・空・エラーの表示を手動確認しました。モバイルのSafariは未検証で、状態遷移と文言のレビューを依頼しています。

This change updates the search panel only. The search API is unchanged.

この変更の対象は検索パネルのみです。検索APIは変更していません。

速度 1.0 / 自動選択 / en-US

Validationには実際に行った確認を書きます。テストを追加しただけなら、実行して成功したとは書きません。未実施の確認をチェック済みにしないようにします。

レビューコメント:理由と重要度を示す​

人ではなくコードや動作を対象にし、修正が必要な理由を具体化します。ラベルは例であり、チームの慣習に合わせます。

Required: Please handle a rejected request here. Otherwise, the loading indicator remains visible after a network error.

必須:ここでリクエストの失敗を処理してください。そうしないと、ネットワークエラー後も読み込み表示が残ります。

速度 1.0 / 自動選択 / en-US

Optional: Could we extract this message into a constant to keep the wording consistent?

任意:文言を揃えるため、このメッセージを定数に切り出すのはどうでしょうか?

速度 1.0 / 自動選択 / en-US

Could you explain why we keep the previous results while the next request is loading?

次のリクエストの読み込み中に前の結果を残す理由を、説明していただけますか?

速度 1.0 / 自動選択 / en-US

質問、必須の修正、任意の改善を分けると、実装担当が対応を判断しやすくなります。Could we ...?という柔らかい形だけで任意だと決まるわけではありません。

修正への返答:予定と完了を分ける​

I'll add a test for the rejected request before requesting another review.

再レビューを依頼する前に、リクエスト失敗のテストを追加します。

速度 1.0 / 自動選択 / en-US

Added a regression test for the rejected request. The focused test suite passes.

リクエスト失敗の回帰テストを追加しました。対象を絞ったテストスイートは成功しています。

速度 1.0 / 自動選択 / en-US

前者は予定、後者は実施済みの報告です。Doneだけより、対応内容と検証結果、必要ならコミットや差分へのリンクを添えます。別タスクにする場合は、合意と記録先を示します。

I suggest tracking this refactoring in a separate issue because it is outside the scope of this fix. Would that work for you?

このリファクタリングは今回の修正範囲外なので、別のissueで管理することを提案します。それでよろしいでしょうか?

速度 1.0 / 自動選択 / en-US

メールでの「確認しました」やコメントの解決だけを正式な承認・マージと同一視せず、リポジトリのレビュー手順に従います。

関連記事・参考資料​