を14日間無料で試してみる
を14日間700以上ものツールと連携。システム障害を自動的に検出・診断するだけでなく、適切な障害対応メンバーをアサインし、デジタル業務全体の修復ワークフローを自動化します。
ITエンジニアであれば、プロジェクト進行中に行なわれるコード変更が、全体にどのように影響を及ぼすかご存じだと思います。
ソフトウェアやアプリを安全で使いやすくするためには、エラーを少なくするためのコードレビューが不可欠です。
しかし、コードレビューは「チェックすべきコードが多い」「コードの変更箇所を探すのが面倒」といった理由で、比較的負担が大きい作業です。
そのようなときにプルリクエストを使用すれば、コードレビューが容易になり、定期的なレビューの習慣が身につくかもしれません。
本記事では、プルリクエストの基本的な概念とそのプロセス、さらにプルリクエストを通じてコード変更を効果的に管理する方法をご紹介します。
目次
プルリクエストとは？プロジェクトを強化する5つのステップ
プルリクエストを使用すると、メインプロジェクトのコードやユーザーへの表示に影響を与えることなく、新しい機能の追加やバグの修正が可能です。
その結果、製品全体の運用を中断させることなく、コード変更やテストをローカルで実施できるでしょう。
プルリクエストとは？
プルリクエストは、ITエンジニアがコードの変更を行なった際、ほかの人にレビューを依頼し、問題がなければメインのコードベースにマージするための機能です。
プルリクエストの機能は以下のとおりです。
- プルリクエストを作成するとレビュー者へ通知される
- ソースコードの変更を見やすく表示する
- レビューワーはソースコードの修正依頼を直接コメント欄に入力できる
プルリクエストの使用によりエラーの発見・修正が容易になり、組織内のコミュニケーションが促進され、作業の目的が明確になるでしょう。
プルリクエストの5つの基本ステップ
- ステップ1：メインリポジトリのフォークとローカルクローンの作成
開発者は、ソフトウェアプロジェクトの元となるコードが保存されているメインリポジトリのフォークを作成し、次にそのクローンをローカルマシン上に作成します。 - ステップ2：ローカルで必要な変更の実施
ローカルマシンで、コードに必要な変更や追加を行ないます。その際、障害の解消か新機能作成かは問いません。 - ステップ3：ローカルでの変更を、フォークされたリポジトリにプッシュ
加えられたコードの変更とテストが完了したら、最初のステップでフォークしたリポジトリに、これらの変更を配置します。 - ステップ4：プルリクエストの作成とレビュー
プルリクエストすると、メインリポジトリを管理する人にレビューするよう通知が届きます。
保守担当者は、開発者がフォークしたリポジトリで行なわれた作業をチェックし、コメントの追加・承認に必要な編集をリクエストします。 - ステップ5：プルリクエストの承認とメインプロジェクトとのマージ
行なった編集に対して、追加のコード変更（コミット）が必要な場合、開発者にその内容が戻されます。編集が不要であれば、保守担当者はプルリクエストを承認します。
その後、プルリクエストが承認されると、フォークしたリポジトリの変更がメインプロジェクトのリポジトリにマージされます。
この更新により、新機能やバグ修正が製品に反映され、最終的にエンドユーザーの画面に表示されます。
対応中の変更作業に行き詰まっている場合には、ほかのチームメンバーからのフィードバックを得て、有効な解決策を模索できます。
そのため、開発者は場合によって、未完成の機能や変更のプルリクエストを行なうこともあります。
プルリクエストを活用すると、メインリポジトリへマージされる前に、プロジェクトの変更に関する全体的なレビューと承認が行なわれます。
その結果、今後起こり得る問題やトラブルを未然に防ぎ、ダウンタイムの発生を抑えます。
プルリクエストの作成
プルリクエストの作成方法は、使用するツールやGitHub、BitBucketなどリポジトリの種類によって異なります。また、GitLabではマージリクエストという名称を使っていますが、同じものと考えて良いでしょう。
一般的に、プルリクエストの作成には、以下の3つの共通要素が含まれます。
ドラフト作成（プルリクエストの準備）
プルリクエストを作る際に、開発者がまず始めるのはドラフト作成です。
コード変更にタイトルをつけ、簡単な説明を記載します。
そして、ソースリポジトリ／ブランチと宛先リポジトリ／ブランチのほかに、変更の種類（新機能なのかバグ修正なのか）に関する情報を含めます。
なお、ドラフト段階のプルリクエストはマージできません。
開発者がプルリクエストを「レビュー可能状態」にマークすることで、初めてマージが可能になります。
マージ
提出されたプルリクエストが承認されると、マージが行なわれます。
保守担当者は問題が見つかった場合には、コメントをつけて、開発者に修正を依頼することが可能です。
修正が完了したら、保守担当者は変更をメインプロジェクトのリポジトリにマージし、本番環境でエンドユーザーに提供します。
変更
マージ前に問題が見つかった場合は、開発者に修正を依頼しましょう。
すると、開発者にアラートが送信され、修正方法についてのコメントやフィードバックが提供されます。
修正完了後には、新しいコミットを反映させたうえでプルリクエストを変更し、再度レビューと承認を受けます。
プルリクエストのテンプレートを作成・保存
プルリクエストの際に利用できるのテンプレートを作成・保存できます。これにより、プロジェクトが迅速に進行して、チーム全員が同じ方法で作業できるでしょう。
テンプレート作成の際は、以下の項目を含めてください。
- コード変更のサマリ：バグ修正か、新機能かを明示して、コード変更の意図や目的を説明する
- 単体テストケース：コード変更をすべてのデバイスやブラウザでテストしたかどうかを明示する
テンプレートの内容は、使用されるリポジトリにより異なります。
テンプレートを活用すると、チームは効率的にコードの修正を提案し、変更をチェックしやすくなるでしょう。
また、ツールによって提供される機能・オプションにより、プルリクエストの作成も容易になるかもしれません。
プルリクエストの例
プルリクエストに関する概要やしくみについて、具体例を見てみましょう。
- 佐藤さんはソフトウェア企業で働いている開発者です。この企業では、さまざまなワインの評価やレビューを行なうモバイルアプリケーションを提供しています。
- 佐藤さんは、アプリを使用するユーザーが「お気に入りワイン5選」をリストアップできる新機能を開発しなければなりません。
- この新機能の開発にあたり、佐藤さんはまずメインリポジトリのフォークを作成し、ローカルマシンにそのクローンを作成しました。
- 次に、ローカルで新機能の開発に取り組みました。
- 開発が完了したため、フォークしたリポジトリにコード変更を配置しました。
- ここでプルリクエストを作成します。
- プルリクエストが送られると、山下さん（リポジトリ保守担当者）が佐藤さんのコード変更をレビューします。
- 山下さんが修正・改善の必要性を感じた場合には、佐藤さんに追加のコミットをリクエストできます。
- 変更リクエストが処理されると、山下さんは佐藤さんのプルリクエストを承認します。
- 佐藤さんの加えた変更は、メインプロジェクトのリポジトリにマージされます。その結果、アプリユーザーは新たな機能を使用できます。
プルリクエストを使用すると、新しいコードのテストが適切に行なわれるため、問題があればすぐに修正できます。
これにより、DevOpsのプロセスをサポートし、効果的なソフトウェア開発を実現するための重要なツールとなるかもしれません。
さらに、PagerDutyを導入することで、開発からリリース、運用保守までのサイクルをスムーズにして、品質と効率を向上できるでしょう。
PagerDutyに関する資料や導入事例は、以下のページからダウンロードいただけます。
https://www.pagerduty.co.jp/resources/
まとめ：プルリクエストを活用して品質とコミュニケーションの向上を実現
プルリクエストを使用する際は、作成したコードの詳細をプルリクエストに記載し、保守担当者がチェックしやすいようにしましょう。そして、良い点だけでなく改善すべき点も明確にし、フィードバックを具体的に行なってください。
また、保守担当者は攻撃的なコメントを避け、ポジティブな内容のフィードバックをするよう、意識することが重要です。
プルリクエストは開発プロセス中の品質維持をサポートします。その後、運用中に発生した問題に対しては、PagerDutyを活用することで即座に対応できます。この両面のアプローチにより、アプリケーションやソフトウェアの信頼性が向上し、ユーザーに対してより優れたサービスを提供できるでしょう。
PagerDutyの14日間無料トライアルは、こちらからご登録いただけます。
https://ja.pagerduty.com/sign-up/
この記事が気になったら
PageDuty公式アカウントをフォロー
この記事の著者
関連ブログ記事
人気記事
検索
タグ目次
