スクリーンショット付き詳細PRテンプレート

ビフォー・アフタースクリーンショット比較テーブルを含むすべてのセクションを備えた包括的なPRテンプレート。フロントエンドやUI重視のプロジェクトに最適。

Standard Templates

詳細な説明

スクリーンショット付き詳細PRテンプレート

フロントエンド、モバイル、デザイン重視のプロジェクトでは、コードレビュー時にビジュアルコンテキストが不可欠です。専用のスクリーンショットセクションを持つ詳細テンプレートは、レビュアーがブランチをローカルにプルせずにUI変更を理解するのに役立ちます。

テンプレート構造

## Description
<!-- 変更内容と動機を要約してください。デザインスペックがあればリンクしてください。 -->

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Code refactoring
- [ ] Style/UI changes
- [ ] Documentation update

## Screenshots

| Before | After |
|--------|-------|
|        |       |

## Checklist
- [ ] プロジェクトのスタイルガイドラインに従っている
- [ ] コードのセルフレビューを実施した
- [ ] 理解しにくい箇所にコメントを追加した
- [ ] ドキュメントに対応する変更を行った
- [ ] 新しい警告が発生しない
- [ ] 修正が有効/機能が動作することを証明するテストを追加した
- [ ] 新規・既存のユニットテストがローカルで通過する
- [ ] 依存する変更がマージ済み
- [ ] リンターでコードをチェック済み

スクリーンショットテーブル

ビフォー・アフターテーブルは標準的なMarkdownテーブル構文を使用します。コントリビューターはGitHub PRエディタに画像を直接ドラッグ&ドロップでき、GitHubが自動的にホストします。2列レイアウトにより視覚的な比較が容易になります。

拡張チェックリスト

詳細テンプレートには標準セット以外の追加チェックリスト項目が含まれます:

  • 依存する変更がマージ済み — 交錯するPRからのマージコンフリクトを防止
  • リンターチェック — CIが実行される前にスタイルの問題をキャッチ
  • 理解しにくいコードのコメント — 長期的な保守性を向上

このテンプレートを使うべきケース

  • UIコンポーネントが頻繁に変更される
  • デザインレビューがPRプロセスの一部
  • チームにビジュアル変更をレビューするデザイナーがいる
  • アクセシビリティテストにビジュアル検証が必要

ユースケース

UI変更のビジュアルレビューが必要なReact/Next.jsアプリケーションのフロントエンドまたはフルスタックチーム。レイアウト変更の影響を示すスクリーンショットが必要なモバイルアプリプロジェクトにも有用。

試してみる — PR Template Builder

フルツールを開く