GitHubでのコードレビューやIssue管理でよく目にする略語について, 実際の使用シーンと共に解説する.
主要な略語一覧
作業状況を示す略語
-
WIP (Work In Progress)
- 作業中であり, まだ完了していない状態を示す.
- PRのタイトルに付けることで, レビュー待ちではないことを明示できる.
-
TBD (To Be Determined)
- 未定の項目や, 後で決定する予定の箇所を示す.
- 仕様書や設計書でよく使用される.
タスク管理用の略語
-
FIXME
- 修正が必要な箇所を示す.
- 緊急度が高い技術的な負債によく使用される.
-
TODO
- 実装予定の機能や追加タスクを示す.
- コード中にコメントとして記載されることが多い.
レビュー関連の略語
-
RFC (Request For Comments)
- レビューやコメントを求める際に使用する.
- 設計段階での意見募集によく使われる.
-
LGTM (Looks Good To Me)
- コードレビューでの承認を示す.
- レビュアーが問題ないと判断した際に使用する.
その他のコミュニケーション用略語
-
IMO (In My Opinion)
- 個人的な意見であることを示す.
- 主観的な提案をする際によく使用される.
-
AFAIK (As Far As I Know)
- 発言者の知る限りでの情報であることを示す.
- 不確実な情報を共有する際に使用する.
-
NIT
- 些細な指摘や軽微な修正点を示す.
- コードスタイルなどの微調整時に使用する.
-
FYI (For Your Information)
- 参考情報として共有する際に使用する.
- チーム内での情報共有でよく見られる.
これらの略語を適切に使用することで, コミュニケーションを効率化できる. 特にWIPやLGTMは, GitHubでの開発フローにおいて重要な役割を果たしている.