00:08
はい、みなさんこんにちは。kkeethことくわはらです。本日もやっていきましょう。
kkeethのエンジニア雑談チャンネルです。この番組では、ウェブ業界に関することや、エンジニアリング、いろんな技術についての雑談などの情報を発信していきたいと思います。
本日ですけども、絶賛今、アドベントカレンダーの、弊社のアドベントカレンダーですね、夢見社のカレンダーの第3日目の担当僕で、絶賛今、記事を書いている途中でありますと。
文字図も結構言ったんですけど、まだまだ書かなきゃいけないので、ダーッと書いていくんですけど、その中で気になったというか、ちょっと取り上げてもいいなと思ったものがありまして。
それがタイトルであります。Pull Request のコメントにメタ情報をつけるといいんじゃないかという話ですね。
メタ情報は何かというと、結構やられている方もいらっしゃるし、僕も他の方がやっているのを普通にパクったとか真似をしたんですけども、レビューするときに、
これは質問のコメントですと、もしくはこれは必ずやってください、もしくは細かいというか、重箱の隅をつつくぐらいなんでいいんですけどみたいなところとか、
あと僕だったらこうしますよみたいなメタ情報をのけるっていうようなことをやっている方がいらっしゃって、僕もパクって最近ずっとやってるんですけど、
レビューするときに必ず先につけておいて、その下にレビューするコメントを書いていくというものですね。
これによって、レビューされた側の人がこのコメントが何を言っているのか、どういうことを期待されているのかというのがパッと見て分かりやすいというものがあります。
種類いくつかあるんですけど、最初はまず ASK ですね。これは文字通り質問です。
これはどういうことなんですかとか、期待の中幅広くとりあえずこの辺質問をするみたいなのを書くことは ASK っていうパッケージですね。
続いて MUST ですね。MUST はもう文字通り、これは必ずやってください、これしないとアプローブできませんみたいなやつですね。
続いて3つ目に IMO ですね。これは私のインマイオピニオンの略で、私だったらこうしますよっていうのですね。
つまり別に間違いとかではなかったり、何か指摘することっていう意味では変更は特にしなくてもいいんだけど、
自分だったらこういう書き方しますよみたいなことをするときに IMO、インマイオピニオンっていうのを書きますと。
これの場合はコメントするとか、もしくは GitHub ってプルリクエストの画面上でこういうような変更したらどうですかっていう
ソースコードのサジェンションで書けるようになりましたよね。
またそれそのまま画面上でそれいいねっていうのでアプローブしたらそのままそれがコミットされてプルリクエストに反映されると。
あれすごく便利ですよね。めちゃめちゃ助かるなって感じです。
あんま使ってる人、僕の周りはあんまいなくてはそういうもんなのかなっていう感じがします。
そういう提案はされるんですけど、じゃあわかったっていうのは自分の手元の方でまたコミットするっていうので。
まあまあ自分の草を生やしたいっていうのはもちろんあるかもしれないですけどね。
さておき3つ目に IMO でしたと。
で4つ目にNITSですね。NITSっていうもので先ほど言いました本当枝葉のような指摘ですね。
めちゃめちゃ細かいしまあ無視してもいいレベルなんだけどっていうようなもの。
NITSっていうのがあります。
03:00
NITSの略って何でしたっけ毎回調べて毎回忘れるんですけど。
略語NITSですけどもニットピックですね。
はいはいっていうのを略してニットピック。ニットピックスかな。
なんかSついた気がしますね。
そのニットっていうのが本当に些細なものっていう確か意味だった気がするんですけど。
でまあNITSですね。
続いてですけども次でNEXT。
これまあ今回はやらなくていいとか他のところの他でプルリクエスト作ってくださいみたいな感じですけど
NEXTっていうのがあります。
あと本当細かいものはあればいっぱいあるんですけどね。
For your information FYI書くものもあったりします。
参考までにっていうものですね。
まあこれはプルリクエストのレビューコメントでつけるか
まあ普通になんかメールの返信とかでつけたりすることもよくあったりしますけど。
他の情報とかを乗っける時にこういうのをつけたりします。
IMOとかでこういう風な提案。
僕だったらこう書けますよって書くんですけどその下にさらにFYIで
そのソースとしてこういうものを参考にしてますよみたいとかですね。
つけたりします。
あとはですねここも細かいし書く書く書く人それぞれなんですけど
ウォンとですね本当はこうしてほしいなみたいなのを書くんですけど
でもあんまり書かないかもしれないですね。
そうやったら普通にIMOに書けばいいじゃん。
レベルとものが多かったりするっていうのはあると思うんですけど。
ウォンとできればこうしてほしいよねみたいなのを書いたりするとか。
まあ大体リファクタリング系で書くイメージはありますね。
ウォンとっていうところでそんなものです。
あといくつかいっぱいがあったりするんですけど。
僕だったらあとはこれすごく学びになりましたなっていう意味も含めて
サンクスつけるとかグッドをつけるとか
っていうのはたまにあたりしますね。
自分の勉強になりましたっていう意味を込めてる感じですね。
でそれはテキスト的に書くこともできますし
いわゆるシールドIOっていうサイトがあって
そこでバッジをつけることもできるんですよ。
シールドIOってご存知か分からないですけど。
ちょうどディスクリプションにも貼りますけども。
たまにOSSのライブラリとか見たり
READMEとかを見るとバッジが書かれていたりすると思います。
左のほうにちょっとグレーなやつで
ビルドーだったりNPMとかついたりしてて
その右に数字だったりがつくようなやつですね。
ここちょっとコードで説明するのかなり難しいし
一目瞭然なのでシールド.IOっていうサイトを行っていただけると
これねって多分分かると思います。
左右に色が分かれてて
そこに何か内容と数字とかが出たりするみたいなやつですね。
こういうのをつけてレビューコメントに貼るっていう方もいらっしゃって
そういうのあるんですねって知らなくて
僕もOSSいくつか出してて
そのREADMEに書いたり
そういうシリーズのバッジを貼ることは僕もあるんですけど
レビューコメントにもこれをつけると結構
なるほどねって思いました。面白いなと思いましたし
いかにも開発をしてるなっていう体験的に
パッと見てこれちょっと楽しいなって思ったりはしましたね。
まあそういうものをつけたりをしますよっていうので
これあるなしで本当にすごく大事だなっていうのは思いましたし
こういうちょっとした改善とかテクニックあると
プールクエストの認識の底とかなくなって
とても良いなっていうのはすごく思ったりはしました。
あとはグッドとサンクスをみんながもっといっぱいつけて
みんなが試験をみんなで共有しあって
06:01
お互いに学び合いができるっていうチームになったら
すごく良いなと思ったりはしてるので
少なくともこれはつけないより絶対つけたほうが良いと思います。
レビューコメントがいくつかあった場合に
これ本人は何を期待してるのかっていうのの認識がずれたりすると
あとで負の遺産が生まれる可能性があるので
こういうことはやっぱりしっかりつけていきましょうというところですね。
エンジニアのチップス的なものだったんですけど
こういうものをつけると本当に素晴らしいので
やっていただければいいなっていうので紹介させていただきました。
参考になれば幸いです。
ではでは、短いですが終わっていきたいと思います。
お疲れ様でした。
