github開発でよく見かける略語一覧
Qiitaのイイネ
がLGTM
になったので
普段の開発で見かけて意味を調べたことのあるワードを解説。
現場によって意味は違うのかもしれないのでそのまんま鵜呑みにしないでちゃんと確認してね。
LGTM:「Looks Good To Me」
「パッと見では良さげ」くらいの意味でapprovedとセットで出すコメント。
レビュアーも完璧じゃないので「LGTM出たんでリリース出来るやろ!ヨシ!」と思ってはいけない。
ちゃんと自分でも他に影響がないかチェックしてね。
略語知らないとよくLTGMとかLGBTとか誤爆する。
WIP:「Work In Progress」
作業中という意味。
プルリクは作ったけどまだ作業中だからマジマジ見ないでって時はプルリクのタイトルに[WIP]hogehoge
って付ける。
一瞬だけ有効化されたプルリクのDraft機能が正式化すればわざわざWIPって付ける必要もなくなるかも。
FYI:「For Your Information」
参考までにって参考サイトのリンク張ったり、実装例のコードを張り付ける時に使われる。
レビュアーは実装例で示したコードの実装意図をちゃんと伝える必要がある。
レビュイーは実装例をそのまま利用してもよいし、そのままだとダメっぽければコメント残して別の実装方法を取るのもよい。
IMO:「In My Opinion」
「個人の意見だけど……」って前置きするときに使う。
でもまあよっぽど賛否の分かれる実装じゃない限りはFYIってしちゃうことの方が多い。
IMHO:「In My Humble Opinion」
IMOの更にへりくだった言い方。
PJでは使わない。OSS開発で日本人がたまに使ってるのを見かける。
nits:「nitpick」
絶対直さなくちゃいけないわけじゃないけど気になる細かい指摘を行う時に使う。
approved押しつつLGTMとセットで出すことが多い。(LGTM with nitsなど)
直すかどうかはプルリク出した人に任せられる。(けど基本は直した方が良いとは思う)
typo: 「typographical error」
タイプミス、スペルミスしてるぞって時に付けるコメント。
例えエディタにスペルチェックツール入れていたとしても人間なので誰しも間違えることはある。
書いてる人は気付きにくいが第三者が客観的に見たときに見つけやすいので指摘されるのはしゃーない。