Appearance
用語集
GitHubのプルリクエストでレビュアーがよく使う用語や、プルリクエスト内で頻繁に登場する用語を表にまとめました。
| 用語 (日本語) | 用語 (英語) | 説明 |
|---|---|---|
| プルリクエスト | Pull Request (PR) | 自身が変更したコードを他の開発者に見てもらい、本体のコードベースに取り込んでもらうためのリクエストです。レビューや議論の場となります。 |
| レビュー | Review | プルリクエストで提案されたコード変更に対して、他の開発者が品質や問題点などを確認し、フィードバックを行うことです。 |
| レビュアー | Reviewer | プルリクエストの内容をレビューする担当者のことです。コードの品質を担保し、問題点を指摘したり、改善案を提案したりします。 |
| アサイン | Assign / Assignee | プルリクエストのレビュー担当者を割り当てることです。アサインされた人は、そのプルリクエストのレビュー責任を持ちます。 |
| マージ | Merge | レビューが完了し、問題がないと判断されたプルリクエストの変更内容を、本体のブランチ(例: mainブランチ)に取り込むことです。 |
| コンフリクト | Conflict | プルリクエストの変更内容と、取り込み先のブランチの最新の状態との間で、同じ箇所のコードが異なる編集をされている場合に発生する競合状態です。手動での解決が必要です。 |
| LGTM | LGTM (Looks Good To Me) | 「問題なさそうです」「承認します」といった意味で使われる略語です。レビューコメントでよく見られます。 |
| WIP | WIP (Work In Progress) | 「作業中」という意味の略語です。プルリクエストのタイトルなどに付与し、まだレビューできる状態ではないことを示します。 |
| Done / Closed | Done / Closed | 作業が完了したことを示すステータスです。レビュー済みでマージ可能な状態や、タスクが終了したことを表します。 |
| Resolved | Resolved | 問題やバグが解決されたことを示すステータスです。タスク自体は終了しているが、特に「問題解決済み」を強調する場合に使います。 |
| コメント | Comment | プルリクエスト内の特定のコード行や全体に対して、質問、意見、指摘などを記述することです。 |
| 提案 | Suggestion | レビュアーがコードの修正案を具体的に提示する機能です。提案された変更をプルリクエストの作成者がワンクリックで適用できる場合があります。 |
| 変更リクエスト | Request Changes / Changes Requested | レビュアーがプルリクエストに対して修正が必要であると判断した場合に選択するレビューステータスです。具体的な修正点をコメントで指摘します。 |
| 承認 | Approve | レビュアーがプルリクエストの内容に問題がないと判断した場合に選択するレビューステータスです。マージ可能な状態であることを示します。 |
| リベース | Rebase | ブランチの分岐元を最新の状態に更新し、コミット履歴を一直線に整形する操作です。コンフリクト解消やコミット履歴を綺麗に保つために行われます。 |
| スカッシュ | Squash | 複数のコミットを一つにまとめる操作です。プルリクエストをマージする際に、コミット履歴を簡潔にするために行われることがあります。 |
| ブランチ | Branch | プロジェクトのコードベースから分岐させて、独立して作業を行うためのものです。プルリクエストは、特定のブランチの変更を別のブランチに取り込むために作成されます。 |
| コミット | Commit | ファイルへの変更をリポジトリに記録する操作です。各コミットには、変更内容を示すメッセージが付与されます。 |
| HEAD | HEAD | 現在チェックアウトしているブランチの最新のコミットを指すポインタです。プルリクエストでは、比較対象のブランチの先端を示します。 |
| Base | Base | プルリクエストの変更を取り込む対象となるブランチ(例: mainブランチ)のことです。 |
| CI (継続的インテグレーション) | CI (Continuous Integration) | コード変更があるたびに、自動的にビルドやテストを実行する仕組みです。プルリクエストにCIの結果が表示され、品質担保に役立ちます。 |
| CD (継続的デリバリー/デプロイメント) | CD (Continuous Delivery/Deployment) | CIに加えて、テストが通ったコードを自動的に本番環境やステージング環境にデプロイする仕組みです。 |
| メンション (@) | Mention (@) | 特定のユーザーに通知を送るために、ユーザー名の前に「@」を付けて記述することです。レビュー依頼や質問などで使用されます。 |
| レビュー依頼 | Request Review | 特定のユーザーやチームに対して、プルリクエストのレビューを依頼する操作です。 |
| 会話を解決 | Resolve Conversation | プルリクエスト内のコメントや指摘事項について、対応が完了したことを示すために、その会話スレッドを「解決済み」にすることです。 |
これらの用語を理解しておくことで、GitHub上でのコミュニケーションがよりスムーズになるでしょう。