Code ClimateのCode Climate BadgeをGitHubに表示する方法

photo credit: Filippo C via photopin cc

GitHubの他人のリポジトリを見ていたら、見慣れないバッジを見つけたので自分のリポジトリにも設定しようと思い、手順などを調べたので、記載する。

Code Climateとは?

Code Climateはコードの品質をチェックするサービスで、リファクタリング関係の書籍等でよく目にする“コードの臭い”に関する兆候を指摘してくれる。Public(=OSS)のリポジトリの場合、無料でサービスを受けられる。

対応言語

現時点では以下の通り。

  • Ruby
  • JavaScript
  • PHP

設定方法

Code Climateにログインする

Code Climate. Hosted static analysis for Ruby, PHP and JavaScript source code.から[SIGN UP WITH GITHUB]をクリックし、GitHubのアカウントでログインする。

Code Climate01

対象のリポジトリを追加する

[Add Open Source Repo]をクリックする。

Code Climate02

GitHub repo nameとして、アカウント名/リポジトリ名を入力後、[Import Repo from GitHub]をクリックする。

Code Climate03

Code Climate Badgeを追加する

しばらく待っていると、以下のように画面が切り替わるので、の部分をクリックする。ちなみにこの数値は4.0が最も良い状態で、“コードの臭い”の兆候が増えると数値が下がっていく。

Code Climate04

ここから欲しいデータ形式を選択すればよい。

Code Climate05