-Qiita記事Part.20- チーム開発で失敗しない！プルリクエストの注意点

こんにちは、ナイトレイインターン生の田中です。
Wantedlyをご覧の方に、ナイトレイのエンジニアがどのようなことをしているか知っていただきたく、Qiitaに公開している記事をストーリーに載せています。
少しでも私たちに興味を持ってくれた方は下に表示される募集記事もご覧ください↓↓

はじめに

はじめまして株式会社ナイトレイの渡辺です。
この記事では、実際に弊社の開発チームが実践しているプルリクエスト（PR）を発行する際に気を付けるべきことをまとめてみました。あくまで我々のチームで意識していることですが、何かのお役に立てればと思っています。

1. PRの目的を明確にする

PRを発行する前にその目的を明確にします。目的が明確でない場合、他のチームメンバーがPRをレビューする際に混乱することがあります。
PRのタイトルに気を配ったり、説明欄を詳細に書くなどして、目的を明確にメンバーに伝えるようにします。

2. コードレビューを受け入れる姿勢を持つ

PRを発行する際はコードレビューを受け入れる姿勢を持つようにします。チームメンバーからのフィードバックを素直に受け入れ、改善点を反映することでプロジェクトの品質を向上させることにつながります。フィードバックに対して感謝の気持ちを忘れないように気をつけます。

3. コミットメッセージに気を配る

コミットメッセージが分かりやすく、意味のあるものであることで、チームメンバーがコードを追跡しやすくなります。

以下は、わかりやすいコミットメッセージにするためのアイデアです。

• 簡潔で明確なメッセージを書く
• メッセージの先頭にキーワードを置く
• 複数の変更がある場合はコミットを分けて書く
• メッセージに参照するチケット番号を含める

4. PRを発行するタイミングを考慮する

一日に複数のPRを発行すると、チームメンバーが混乱することがあります。たとえば、一日に複数のPRを発行すると、他のチームメンバーがPRを追跡するのに混乱することがあります。また、一つのPRに多数の変更を含めてしまうと、チームメンバーがレビューに多くの時間を費やすことになります。このため、PRを発行するタイミングは、変更の規模や内容を考慮し、適切に決定する必要があります。

5. PRの説明欄を詳細に書く

PRの説明が詳細であると、チームメンバーが理解しやすく、PRの品質が向上することが期待できます。説明には、何を変更したか、どのような理由で変更したのか、変更したコードの詳細などを含めるようにします。

6. 不必要な変更を避ける

不必要な変更が含まれている場合、チームメンバーがPRをレビューする際に混乱することがあります。また、不必要な変更が含まれていると、プルリクエストのレビューにかかる時間が増えるため、開発の効率が悪化することがあります。

7. コード規約に従う

PRを発行する際は、コード規約に従うことが望ましいです。コード規約に従うことで、チームメンバーがコードを理解しやすくなり、コードの品質が向上することが期待できます。

8. タスク管理ツールとの連携

PRに対応するタスクがある場合は、タスクの詳細をPRの説明に含めることで、チームメンバーがタスクの進捗状況を把握しやすくなります。

まとめ

プルリクエスト（PR）を発行する際には、上記のような点に気を配ることが重要です。これらの注意点を守り、品質の高いコードを開発することが目指されます。また、チーム開発においては、コミュニケーションを密にすることが重要であるため、PRの発行はその一つの手段として活用することが望ましいです！

最後に

私たちの会社、ナイトレイでは一緒に自社開発のWebサービスを盛り上げてくれるエンジニアメンバーを募集しています！
基本的には直接ユーザーと接することのないポジションですが、セールス部門から
「顧客の声」を教えてもらったり、希望すればユーザーとのMTGに参加することも可能です。
モチベーションの高め方はあなた次第。

このような方は是非Wantedlyからお気軽にご連絡ください（もしくはこちらまで recruit@nightley.jp ）

✔︎ 自社Webサービスの開発で事業の発展に携わってみたい
✔︎ 自分が開発したサービスで地域活性化に貢献したい
✔︎ 位置情報ビッグデータに興味があり、新しい活用方法を提案したい
✔︎ 地理や地図が好きで仕事中も眺めていたい

一つでも当てはまる方は是非こちらの記事をご覧ください
「受託開発一切なし！自社WEBサービスを社長やセールスチームと一緒に開発！」

▼ナイトレイとは？