🥑
レビューコメントでよく見る略語・表現10選
はじめに
現場でレビューを受けた人が「LGTM」と返事をもらっていて、「これってどういう意味?」とプロジェクトチーム内でちょっとした話題になりました。
前の現場ではソースコードを修正してレビューを受けるという流れが一般的で、こういった略語を見かけることが多かったのですが、少し島が違えば全く使わないというケースもありますよね。
そこで今回は、GitHubなどでよく見かけるコメント表現や略語を自分なりに調べてまとめてみました。
これからレビュー文化に触れる人や、新しい現場に入った方の参考になれば嬉しいです!
よく見るGitHubコメント表現&略語まとめ
| 表現 | 意味 | 説明 |
|---|---|---|
| LGTM | Looks Good To Me | 「いい感じだね!」「OKだと思うよ」という意味で、レビューでよく使う定番コメント |
| WIP | Work In Progress | 「作業中です!」という意味。まだマージしないでね〜の合図に使われることも |
| PR | Pull Request | コード変更をレビュー・マージしてもらうための依頼。GitHubではこの単語よく出るよ! |
| nits / nitpicks | ちょっとした指摘 | 重要じゃないけど気になる小さな改善ポイント。「気にしなくてもいいけど〜」って時に添える |
| IMO | In My Opinion | 「私の意見だけどね」ってやんわり言いたい時に使うよ。柔らかく主張したいとき便利 |
| FYI | For Your Information | 「参考までに」ってニュアンス。情報共有のときにさらっと入れる感じ |
| TBD | To Be Determined | 「未定」や「あとで決めよう」って意味で、設計や要件の段階でよく出てくるワード |
| RFC | Request For Comments | 意見募集中!の意味。「この仕様でどうかな?」ってチームに投げる時などに使う |
| rebase | ブランチの履歴整理 |
git rebaseで履歴をきれいに整える操作。コンフリクト注意⚠️だけど慣れると便利 |
| merge | ブランチの統合 | PRをマージする = メインブランチに変更を取り込むこと |
プチ例文集
- LGTM! マージお願いします
- PR 作っておきました。ご確認お願いいたします!
- nits: 変数名がちょっと気になりましたが、お任せします〜
- FYI: 来週から新人さんが入る予定です(また共有しますね!)
- IMO: この処理、別メソッドに分けた方が読みやすいかも?
- RFC: この仕様案どうでしょうか?ご意見いただけると助かります!
おわりに
自分も普段からこういった略語をあまり使う機会がなくて、毎回「なんだっけこれ?」って調べては忘れて…を繰り返しています(笑)
こうして一覧にまとめておくと、「あ、これ見たことある!」って思い出せるので、自分自身の備忘録としても役に立ちそうです!
Discussion