読者です 読者をやめる 読者になる 読者になる

SideCI Blog

自動コードレビューサービスSideCIを提供している株式会社アクトキャットのコーポレートブログです。



男ばかりの会社に カワ(・∀・)イイ!! 指摘ちゃんを採用しよう。萌えキャラによるコードレビューの自動化 on GitHub

Other

こんにちは。
私達が運営しているSideCIは、RuboCopやBrakeman、PHP_CodeSnifferなどの静的解析ツールを利用したGitHub連携のコードレビュー機能を提供しています。
コードレビュー機能をONにした状態でPullRequestをOpenすると、すぐにコードレビューが実行されます。

ところで、こういった自動コードレビュー機能、皆様はどのようにお使いでしょうか?

SideCI Sign Up直後のGitHubの状態

普通に自身のアカウントでSign Up、設定するとPull Requestはこのような感じになります。

GitHub PullRequestイメージ_1 GitHub PullRequestイメージ_2

いつもの開発者アイコンがコメントするのは、なんだか面白く無いですね。
Pull Requestへのコメントは毎日見るものです。毎日顔を合わせるアイコンだからもっと大切にしたい!

また、これはbotなのかそれともエンジニア自身なのかが分かりづらいです。同じアカウント・アイコンですからね。。。

Bot専用アカウントを導入しよう

ということで、追加でbot用のアカウントを登録するというのはいかがでしょうか?
毎日見るbotなので、凛々しいアイコンが良いと思います。
はい!例えば以下の様な素敵な画像を用意します。

指摘ちゃん(仮)イメージ

なお、この画像はSideCIのオリジナルキャラクターで名前はまだありません。
仮で「指摘ちゃん」ということにしておきます。素敵なお名前を募集しております!(笑
また、皆様でお好きな名前で読んで頂いても構いません。
(私事ですが、私はラブライブでは真姫ちゃん推しなので勝手にマキちゃんと名付けようかとしております

bot用のGitHubアカウントを登録する

それではさっそくGithubでアカウント登録しましょう。メールアドレスが必要ですが、すぐ登録できます。

指摘ちゃん(仮)のGitHubアカウントイメージ

次にアイコンの設定です。
Githubのprofile画面から"profile picture"にドラッグ&ドロップすることでアップロードすることが出来ます。

指摘ちゃん(仮)のアイコン設定イメージ

このとき、素材にもよりますが、顔がわかりやすいように顔部分をアップするなどの調整をすると良いかもしれません。 現在のGitHubは、コメントするユーザのアイコンが非常に小さく表示されてしまうので。

アップにした指摘ちゃん画像も用意しました。

指摘ちゃん(仮)のアップロード済みアイコンイメージ

次にOrganizationに招致します。
Organizationの"invite someone"ボタンを押してボットのアカウント名を入力します。

招待前のオーガニゼーションメンバ状況

github登録時に登録したメールアドレスにinviteメールが送られるので、承認します。
無事招致できました!

招待後のオーガニゼーションメンバ状況

画面右端の一覧に指摘ちゃんが追加されています。
この女の子が会社にjoinしてくれた感覚に陥りますね!

ちなみにこのとき、 デフォルトではこのbotがこのOrganizationに属しているということは、公開されません。
つまり、どんなに萌え萌えなキャラを設定しても安心です!

SideCI上の設定・コメントユーザの選択

次に、SideCIの comment user から彼女をチョイスします。
Comment userに彼女の顔が出てこない場合は、彼女のアカウントでSideCIにログインすると、出てくるようになります。 もしここで表示されない場合には、write以上の権限がrepositoryに対して与えられているかを確認して下さい。

SideCI上でのコメントユーザ設定イメージ

これで晴れてカワ(・∀・)イイ!!指摘ちゃんから指摘されるようになりました!やったね!

指摘ちゃん(仮)による指摘イメージ

いかがでしたでしょうか。

まとめ

  • ボット用のgithubでアカウントは可愛く作ってみよう!
  • 外側からはオーガニゼーションの中にどんなボットがいるかは見えない!
  • 可愛いボットから指摘を受け、モチベーションを維持しよう!

SideCI公式オリキャラは下記からダウンロード下さい。

全身イラスト:
f:id:sideci:20150820134448p:plain 指摘ちゃん(仮)の全身イメージ

アップイラスト:
指摘ちゃん(仮)のアップイメージ