ククログ

株式会社クリアコード > ククログ > クリアコードの開発の様子をフォローしやすくしました

クリアコードの開発の様子をフォローしやすくしました

クリアコードでは、社名からわかる通り、日頃からクリアなコードを書くべく日々コードと向き合っています。そのために「みんながみんなのコードを読む文化」を維持しています。

クリアコードでは自分たちがクリアなコードを書くだけではなく、自分たち以外の人たちがクリアなコードを書くことを支援したいと考えています。そのために、他社の開発チームに「みんながみんなのコードを読む文化」を根付かせる支援をするコミットへのコメントサービスも提供しています(導入事例)。また、クリアなコードを書くために実践しているノウハウを文書化して公開しています。例えば、以下のようなノウハウです。

これらのような集中的な支援やまとまった文書も役に立つと信じていますが、クリアコードの日々の開発の中にも役に立つノウハウが転がっているはずです。そして、そのノウハウは私たち自身がまだ気づいていないまま無自覚にやっているものもあるでしょう。無自覚なものは自分たちで文書としてまとめることができないため、社外の人たちと共有する機会がありません。

そこで、クリアコードの開発の様子をフォローしやすくしました。具体的にはクリアコードが開発しているフリーソフトウェアのコミットメールを流しているメーリングリストcommit@clear-code.comに誰でも参加できるようにしました。

このメーリングリストにはGitHubのclear-code organizationにあるリポジトリーのコミットメールとTravis CIからの通知メールが流れています。milter managerなど別organizationにしているプロジェクトは以前から公開のメーリングリストに流していますが、それらについては変更ありません1

commit@clear-code.comではコミットへのコメントサービスで示しているように、クリアコードのメンバーがコミットに対してコメントすることがあります。コミットへのコメントサービスがどのように実施されるかについて興味のある方や、体験してみたい方、クリアコードのメンバーの日々のコミットからノウハウを学びたいという方はぜひ購読してみてください。

今、クリアコードではインターンシップを実施していますが、その様子をclear-code/internshipに記録しています。この記録もcommit@clear-code.comに流れます。

インターンシップでは、今まで無自覚にやっていたことを説明する場面がたくさんあります。そのたびに、どうしてそのようなコードを書くのかという「理由」を明確にしたり、どこに気をつけたり着目したりしてコードを書いているのか、ということを明確にしています。例えば、コメントを書かないといけないところは本当にコメントが必要なのかを考えるということに気をつけているということを自覚しました。

このインターンシップの記録をみれば、クリアコードではどのように考えて開発しているかがわかるはずです。コミットへのコメントサービスを検討している方や、クリアコードで仕事としてフリーソフトウェアを開発したいという方は参考にしてください。なお、クリアコードの選考プロセスはパッチ採用です。

  1. 別organizationにしているプロジェクトへコミットすることが多いので、実は、commit@clear-code.comの流量はそれほど多くありません。