コミットへのコメントサービス - クリアコード

資料ダウンロード

コミットへのコメントサービス

株式会社クリアコード > サービス > コミットへのコメントサービス

改良版サービスのおしらせ

現在は、本サービスの改良版を「コードリーダー育成支援」として提供しています。本サービスで大事にしていることはコードリーダー育成支援サービスでも同様に大事にしていますので、本サービスにご興味がありましたらお問い合わせください。開発チームにあった進め方をご提案します。トライアルを実施して理解を深めることもできます。

クリアコードは、よいコードを書くことを当たり前にするためには、まず「みんながみんなのコードを読む」文化にすることからはじめるのがよいと考えます。

そこでクリアコードは、「みんながみんなのコードを読む」文化づくりを支援する目的で、「コミットへのコメントサービス」を提供します。

みんながみんなのコードを読む文化とは

みんながみんなのコードを読むとは

ここでいう「みんな」とは同じ開発チームのメンバーのことです。「みんなのコードを読む」ということはコミットされたすべてのコードを読むということです。それを「みんなが」実践します。もし、コミットされたコードを読んで気になることがあったらコメントします。間違いに気づいた場合は修正します。ここでいう「コードを読む」という作業はレビューのように堅苦しいものではありません。「間違いは絶対見逃さないぞ！」という意気込みでやるものではなく、「同じ開発チームのメンバーがどのようなコードを書いているか」を共有するためにやるものです。

なぜみんなのコードを読むのか

よいコードを書くには、コードを読む側の視点がなければなりません。それは想像して手に入るものではなく、実際に読むことを経験して手に入るものです。みんなのコードを読む理由はコードを読む側の視点を身につけるためです。

よいコードの書き方を知っていると、よいコードを書くための大きな助けになります。みんながみんなのコードを読んでいれば、開発チーム内でよいコードをコミットすることにより、よいコードの書き方をみんなで共有することができます。口頭や文章での説明だけではなく、実際に動くコードでよいコードの書き方を伝える方が実践的なためより理解が進みます。そのため、みんなでみんなのコードを読みます。

みんながみんなのコードを読む文化で期待される効果

個人、開発チームそれぞれに次のような効果をもたらします。

個人に対して
  • コードを読むことに慣れてくると、よいコードを見つけることができるようになる
  • 開発メンバーの書いたよいコードの書き方を自分のコードの書き方に取り込めるようになる
  • 読む人の視点でコードを書けるようになり、自分の書くコードが整理されて、読みやすくなる
開発チームに対して
  • よいコミットを共有できる
  • 開発チーム内のコードによるコミュニケーションが活発になる
  • 誤りが見つかりやすくなる
  • よいコードを共有するための仕組みができ、新しい人にも伝えやすくなる

みんながみんなのコードを読む文化の作り方

次のプロセスによりみんながみんなのコードを読む文化を作ります。

1. コードの読み方を学ぶ

以下の書籍や記事を読み、実際に開発チームで一緒にコードを読んで、コードの読み方を学びます。

2. コミットメールが流れる仕組みを作る

「みんなにみんなのコードが届く」環境を作ります。

開発チーム全員に差分付きのコミットメールが届くよう環境を整備します。

コミットメールを配信する仕組みの作り方についてはクリアコードから情報提供します。

3. コミットメールを読む

開発チームのメンバーそれぞれが自分のペースでコミットメールを読みます。読むことに慣れてきたら、気づいた点にコメントします。

コミットを読みやすくするためのアイデアを出し合うのがよいでしょう。

さらにメンバー全員は、以下の内容を毎日記録します。記録する方法としてコードと同じリポジトリにコミットする方法があります。

4. 読まれることを考えてコミットする

読んだ経験を活かしてコミットします。

読みやすいコミットを実践する
コミットのサイズを小さく、名前はわかりやすく、インデントを揃えるなど、読んだ側が理解しやすいようにするためにはどうすればよいか、自分が読んでいるときのことを思い出しながら読みやすいコードを書いてコミットします。
よいコミットを真似する
他のメンバーのコミットを読んでこれはよいコードだと思ったら積極的に真似をします。よいと思ったものを実践することによって、よいコードが書けるようになり、また真似をされた側は励みになります。

5. コミットメールを読む文化がどのくらい根付いてきたか定期的に測定する

「コミットメールを読むこと」と「読まれることを考えてコミットすること」がどのくらいできるようになったかをデータから分析します。1コミットあたりのサイズや1日のコミット数といったデータや、3で記録した日々のコミットが材料となります。

クリアコードが提供するサービス

みんながみんなのコードを読む文化をつくるのための上記プロセスに対して、以下のサービスを提供します。

導入研修

DevLOVE 2012でのセッション「リーダブルコードを読んだ後」と同様の内容を導入研修として実施します。

研修内容は以下の通りです。

コミットメールを読んでコメントする

クリアコード担当者も開発チームと同じようにコミットを読みながら、より効果的にコミットを読めるようになるよう開発チームを支援します。

データ分析

定期的に以下のデータを収集して分析し、レポートします。

サービス提供期間

3ヶ月を目安とします。

コミットメールを読むこと、読みやすいコミットをすることを習慣づけるためには、継続することが不可欠です。3ヶ月のサービス期間で、コミットメールを読む文化の浸透を図るとともに、開発チームだけで自律的に続けられる体制となることを目指します。

価格

サービス 価格（消費税別） 備考
導入研修 100,000円/回 1回5名まで。4時間。
コミットメールを読んでコメントする 100,000円/月 担当者1名。読む時間の目安: 30分/日
データ分析 30,000円/回 毎月1回実施
3ヶ月トータル 490,000円 研修1回、コメント、データ分析3ヶ月

備考

お問い合わせ

お問い合わせフォームからお問い合わせください。

ご不明な点などありましたら、お気軽にご連絡ください。