はじめに
みなさんは、コードレビューをする際にプレフィックスを使っていますか？
こんなやつです。
[MUST]XXXの時にバグが発生する可能性があります。今まで使っていなかったのですが、レビューコメント時、相手に意図を正確に伝えるために有用だったので使うようにしました。
そこで、今回はプレフィックスと意味を忘れがちなので自分用メモとして残します。
レビューコメントのプレフィックス一覧
| プレフィックス | 意味 |
|---|---|
| MUST | 必ず修正が必要。バグ、セキュリティ、重大なパフォーマンス問題など。 |
| WANT | 修正を推奨。改善点、より良い実装、可読性向上など。 |
| ASK | 質問や確認を求める。コードの意図、動作、設計などへの疑問。 |
| FYI | 情報共有。修正不要。参考情報や関連情報など。 ※For Your Informationの略 |
| NITS | 細かい指摘。typo、インデント、命名規則など、機能に影響なし。 ※Nitpickの略 |
| IMO | 個人的な意見。 ※In My Opinionの略 |
| IMHO | 個人的な意見。他のレビュアーと意見が異なる可能性も考慮。 ※In My Humble Opinion |
| SUGGEST | 代替案の提案。別の実装方法や設計など。 |
| TODO | 今後の課題。現PRでは対応しないが、将来対応が必要な点。 |
| QUESTION | 質問。ASKとほぼ同義。 |
| DISCUSS | 議論/検討が必要。設計や実装方針について議論を深めたい場合。 |
おわりに
便利なのでぜひ使ってみてください。
参考
よく使うレビューコメントのプレフィックスまとめ | DevelopersIO
dev.classmethod.jp
コードレビューにラベルを付けるだけでチームの心理的安全性を高めた話
zenn.dev
コメント