先日、弊社の技術ブログに久しぶりに記事を投稿しました。
内容としてはOSSのコードを初めて読む人に向けて、どのような流れでコードを読んでいくのかを実際のOSS(gimei)を用いて紹介していくという記事です。
本当は自分のブログに投稿したかった内容です。
とはいえ、チームのメンバーに「OSSのコードを読み始めるきっかけになってほしい」という思いで投稿しました。
...というのも以前から、以下のような話をチームのメンバーから聞いていたからです。
- OSSのコードを読んでみたい
- 実際に読むとなるとハードルが高くて、何からやればいいのか分からない
- コード量が多すぎてどこから読めば良いのか分からない
- どのOSSのコードを読めば良いのか分からない
何か難しそう...を払拭したい
記事にも書いたように、良いエンジニアになるには良いコードをたくさん読むことが重要だと考えています。
現代では、ありがたいことに良いコードが巷に溢れているわけで、これを活用しないわけにはいきません。
しかし、約一年前からOSSのコードを読んできましたが、自分も元々は「何か難しそう...」というイメージを持っていました。
実際に難しかったのは事実なのですが、読み進め方や要領が分かってくると、それほど難しいものばかりではないと感じるようになりました。
もちろん読むのに時間はかかりますし、自分が全く知らないドメイン領域のコードを読むのはしんどいです。
ただ、同じような体験を通じて、コードリーディングのきっかけになってくれると嬉しいです。
「何か難しそう...」を払拭するための、近道を伝えられたらと思っております。
記事内で紹介できなかったこと
他にも記事内で伝えたかったことがあるのですが、情報量が多くなってしまうので記載しませんでした。
一言で言えば、コードを読むだけではなく、実際に手元の環境でOSSコードをデバッグする...といったテクニック的な内容です。
実際にOSSのコードを読み始めてから役立つかもしれない内容なので、入門記事に書くのは違うかなと感じました。
ただ、こういったテクニックをたくさん知っておくと、よりコードを読むのが楽になる上、早くなります。
機会があれば別の記事として、投稿するかもしれません。
最後に
改めてになりますが、この記事が「OSSのコードを読んでみる」きっかけになってくれたら嬉しいです。
そんな大きなパワーはないでしょ...とは思いつつ、一人でも「あの記事を読んでみて、やってみましたよ」なんて言われたら泣いちゃうと思います。
前提として相手が本当に「OSSのコードを読んでみたい」と興味を持っているかは分からないので、こちらから「OSSのコード読めよ」と押し付けることはできません。 なので今回は、弊社の技術ブログに記事を投稿するという形で、何か変化があればと期待しています。
少しでも「ええな〜」と思ったらはてなスター・はてなブックマーク・シェアを頂けると励みになります。
