sekaie engineers' blog

セカイエ株式会社が主催するエンジニア勉強会について

コーディング規約を決めよう

こんにちは。
子供の頃から「その視界で見えているの?」「いつも眠そうやな」と言われている田中です。
ええ。眠くありませんし、視界良好です。

さて、先日勉強会で行った「コーディング規約を決めよう」の内容は以下の通りです。

コーディング規約…と聞くと
「んなもん作成しなくても、コーディングぐらい自由にさせてくれよ」
「動いたら、それでええんやん」
「規約を守ってる時間はないねん。リリースが優先やろ」
という声がどこかしら、聞こえてきそうです。

はい。その気持ちわかります。
がしかし、仕事は一人でやっているわけではないので、 みんなで合わせて見やすさやミスの防止、メンテナンス性をより高めていきましょうね。
というお話。

1.現在のリノコのコーディング規約

初めに、現在リノコのコーディング規約を見直しました。
メンバーが増えてきたということもあり、規約を見直すいいきっかけになりました! 見直すことで、課題や問題点を再認識することができました。

問題点として、

  • コーディング規約があったもののメンバーに共有ができていない。
  • コーディング規約があるものの更新が止まっており、古い状態のまま。

これでは、いけません。
ただ、原因はわかっています。
コーディング規約だけが記載されているのではなく、いろいろな情報に埋もれてしまっており、見た目もあまり整備されておらず、更新がしにくい状況なのです。
わかっているのにやらないのは、ダメですよね。
では、やりましょう。

改善案

  • コーディング規約をどう運用・共有・更新していくか
       ↓
    GitHubwikiを使用し、共有・更新する

2.他のコーディング規約を見てみる

紹介&参考にさせていただきました。
ありがとうございます。
とても勉強になります。 こういった他のサイトのガイドラインや規約を見ることで、トレンドを見ることは重要な一つですね。
もちろん、トレンドを追うことばかりではいけないですが。。。

3.コーディング規約を決めよう

さぁ、今回の本題はこちら。

ひとつひとつの紹介は、ここではしませんが、
「こればっかりは決めておかないといけない」ことを決めました。

それは、、、

「改行コード」 「インデント」です。


・・
・・・
「おいおい、今更、、、何言ってるんだ。。。」

そうなんです。
恥ずかしながらリノコのサイトは、統一できてないんです。。。
でも、安心してください。…動いてますよ。
いやいや、あかんあかん!

統一します!

改行コード → LF(Linuxで動いているため)
インデント → ソフトタブ(スペース4つ分)

こちらに決めました。
インデントは、視認性やトレンドなども考慮してソフトタブ(スペース4つ分)にしました。
ただ、改行コードの方は、変更してしまうとコンフリクトが発生してしまい、どこが修正箇所かわからなくなるため、年末のあたりにまとめてしたいと考えています。

また、コーディング規約を決めることにあたり、 SASSを使いたいとの声が上がり、、、

SASS・Gulp導入します!

f:id:sekaie:20151123214215p:plain
前々から要望のあったSASS・Gulp導入します。
こちらも決まっちゃいました。
学習コストは少しありますが、より良いサイト作りを目指していきましょう♪

4.コーディング規約を管理しよう

先ほども、「GitHubwikiを使用し、共有・更新する」とお伝えしましたが、この方法が正しいものかわかってません。
書いたものの使用されなければ、「絵に描いた餅」みたいなものです。
実際に運用してみて、使いにくければまた別の方法もありだと思ってます。

しかも、こういったものはチームやメンバーの協力が不可欠です。
「みんなで守っていこうね」という意識が大切です。
もし、これは違うんじゃないかなどがあれば、それもみんなで共有して解決できればいいなと思っております。

補足

こちらは、簡単に説明させていただきました。
ただ、この2つはGulpで解決できるとのこと!
Gulpってすごいんだなぁ。。。
ので、乞うご期待!!

しまいに

最後になりましたが、勉強会も今回で15回目になりました。
「小さな継続 大きな実り」です。
みんなの話は私にとって、目から鱗です。
いろいろな情報や意見を話し合うことはいいですね♪

ただ、…勉強会2時間もしてしまった。。。
みんなの時間を共有しているので、時間は守らないといけないなと反省。
時間は守りましょうね。
高田純次のような大人になりたいな。

ほな。