プルリクエストテンプレート

プルリクエストのテンプレートを使うことで、プルリクエストの作成時に必要な情報を簡単に記入することができます。プルリクエストのテンプレート例を以下に示します。

パス: .github/PULL_REQUEST_TEMPLATE.md

---
name: プルリクエストテンプレート
about: プルリクエストを作成する際のテンプレートです
title: '概要: [概要を記入]'
labels: ''

---

## 概要
<!-- このプルリクエストで何をしたのか、変更の目的を簡潔に説明してください -->

## 変更内容
<!-- このプルリクエストで行った変更内容を簡潔に説明してください -->

## 関連リンク
<!-- 本追加・変更の背景となるissue、backlog、Slack等のリンクを記載してください -->

## スクリーンショット
<!-- 
変更内容に関連するスクリーンショットがあれば貼り付けてください 
スクリーンショットの数は最小限に抑え、変更内容を理解するために必要なものに留めてください
-->

## チェックリスト
<!-- 
チェックリストの記載内容について不明な点があれば、レビュアーに確認してください
チェックが完了した場合、[x]に変更してください 
-->

- [ ] PR作成前にマージ先のブランチを最新にし、競合を解消している
- [ ] PRは一つの目的に向けられている
- [ ] コードのレビューを依頼する
- [ ] 担当者をアサインする(通常は自分自身)
- [ ] 自動テストを実行し、全てのテストが成功している
- [ ] lintワークフローを実行し、全てのチェックが成功している
- [ ] PR作成後、issueをリンクする
- [ ] PRに対応するドキュメントを作成、更新し、PRに含めている
- [ ] 後方互換性がない変更を行った場合、`major`labelを付与する
- [ ] 新機能を追加した場合、`feature`labelを付与する
- [ ] バグを修正した場合、`bug`labelを付与する

## その他
<!-- その他、特記事項があれば記載してください -->

### 前提プルリクエスト
<!-- このプルリクエストの前提となるプルリクエストがあればリンクを貼ってください -->

このテンプレートを使うことで、プルリクエストの作成時に必要な情報を簡単に記入することができます。プルリクエストのテンプレートは、プロジェクトごとに異なる場合があるため、プロジェクトに合わせてカスタマイズすることができます。

レビューのポイント

プルリクエストのレビューを行う際には、以下のポイントに注意してレビューを行うことが重要です。

コードの品質

プルリクエストのレビューでは、コードの品質を確認することが重要です。コードの品質を確認する際には、以下のポイントに注意してレビューを行います。

コードの可読性：コードが読みやすいかどうかを確認する
コードの効率性：コードが効率的に動作するかどうかを確認する
コードの一貫性：コードが一貫性を持っているかどうかを確認する
コードのセキュリティ：コードがセキュリティ上の問題を含んでいないかを確認する

テストの実行

プルリクエストのレビューでは、テストの実行を行うことが重要です。テストの実行を行う際には、以下のポイントに注意してレビューを行います。

ユニットテスト：コードの各部分が正しく動作するかどうかを確認する
結合テスト：コードの複数の部分が正しく連携するかどうかを確認する
E2Eテスト：コードがユーザーの操作に正しく反応するかどうかを確認する

ドキュメントの作成

プルリクエストのレビューでは、ドキュメントの作成を行うことが重要です。ドキュメントの作成を行う際には、以下のポイントに注意してレビューを行います。

コードの説明：コードの動作や目的を説明するドキュメントがあるかどうかを確認する
ユーザーガイド：ユーザーがコードを使用する際の手順や注意点を説明するドキュメントがあるかどどうかを確認する
APIドキュメント：APIの仕様や使用方法を説明するドキュメントがあるかどうかを確認する

レビューのコメント

プルリクエストのレビューでは、適切なコメントを残すことが重要です。コメントを残す際には、以下のポイントに注意してコメントを残します。

肯定的なコメント：コードの良い点を褒めるコメントを残す
改善点のコメント：コードの改善点を指摘するコメントを残す
質問のコメント：コードの理解に関する質問を残す
意見のコメント：コードの設計や実装に関する意見を残す

レビューの手順

プルリクエストのレビューを行う際には、以下の手順に従ってレビューを行います。

プルリクエストの確認
プルリクエストの概要を確認する
変更内容を確認する
関連リンクを確認する
スクリーンショットを確認する
チェックリストを確認する
その他の特記事項を確認する
前提プルリクエストを確認する
コードの品質の確認
- コードの可読性を確認する
- コードの効率性を確認する
- コードの一貫性を確認する
- コードのセキュリティを確認する
テストの実行
- ユニットテストを実行する
- 結合テストを実行する
- E2Eテストを実行する
ドキュメントの作成の確認
- コードの説明を確認する
- ユーザーガイドを確認する
- APIドキュメントを確認する
レビューのコメントの残し方
- 肯定的なコメントを残す
- 改善点のコメントを残す
- 質問のコメントを残す
- 意見のコメントを残す
レビューの結果のフィードバック
- レビューの結果をプルリクエスト作成者にフィードバックする
- レビューの結果をプルリクエスト作成者と共有する
- レビューの結果をプルリクエスト作成者と議論する

プルリクエストのレビューを行う際には、上記の手順に従ってレビューを行うことで、プルリクエストの品質を向上させることができます。