はじめに
本記事では自動でコードの品質管理を行ってくれるCode Climateの導入方法を解説します。特に、一人で開発をしていて自分の書いたコードをレビューしてくれる人がいないという方や、チームで開発をしているが、機械的にレビュー可能な部分は自動化することでレビューのコストを下げたいという方向けにツールの導入方法をお伝えします。
前提条件
- GitHubのアカウントとパブリックリポジトリを作成している
- GitHubの基本的な使い方を理解している
目次
導入手順
Code ClimateとGitHubを連携する
以下のリンクにアクセス
Sign up with Githubをクリック
Authorize codeclimateをクリック
もう一度Authorize codeclimateをクリック
Nextをクリック
Free for open source. Forever.のAdd a repositoryをクリック
Authorize codeclimate
品質管理の対象としたいリポジトリを選んでAdd Repoをクリック
Seee the Resultsをクリック
こんな感じでサマリーが表示されればokです
プルリクエストを作成したタイミングでフィードバックをもらえるようにする
Repo Settingをクリック
GitHubをクリック
Pull request comments のSet upをクリック
Installをクリック
先ほどの設定画面に戻りラジオボタンをオンにしてSaveボタンをクリック
Pull request status updatesのInstallをクリック
適当にPull Requestを作ってファイルの変更状態を確認すると以下のようにフィードバックが返ってきます(画像はコードが複雑すぎますという注意が書かれています)
これで自動コード品質管理ツールの導入は完了です
参考文献
本記事の作成にあたっては以下の記事を参考にしました