pr-comment.md

PR コメントプリフィックス

[MUST]: 絶対直してほしいなというときに付けます。強い指摘になるので、言葉遣いには少し気をつけます

[MUST] 通信エラーのハンドリングが不足しているので処理の追加をお願いします！
[MUST] 不要な変更がコミットされているので取り消してほしいです！

[IMO]: 自分ならこうするかな〜、自分はこう思うのだけどどうだろう？というときに

• In my opinionの略

[IMO] `何かしらのコード` みたいに書いたほうがスッキリすると思います！
[IMO] この処理はxxxというクラスに移したほうが責務的には良さそうです。

[NITS]: 細かい指摘や、軽い修正をして欲しいときに(nits pick)

[NITS] ここのコメント、不要なら消しちゃっても良さそう。
[NITS] `console.log` 残ったままになってる 👀

[Q]:ここ質問したい！という時に付けます。

• Questionの略
• 実装で不明瞭だった点や、そもそも自分の知らないことについて聞いたりします。

[Q] ここの処理は非同期で実行される可能性はありますか？
[Q] xxxって機能(書き方)があるんですね、具体的にどういうものなのでしょうか？

---

引用

• 僕がコードレビューの時に気をつけていること