コードレビュー関連の用語

コードレビュー関連の用語

LGTM

定義: LGTMは「Looks Good To Me」の略で、「問題ないと思います」という意味です。コードレビューで、承認する際に使用されます。

なぜ重要なのか:

• 効率的なコミュニケーション: 短い表現で承認の意思を伝えられる
• レビューのスピード: 明確な承認により、マージが迅速に行える
• チームの文化: チーム内で共通の用語を使うことで、コミュニケーションが円滑になる

使用例:

PR #123 のレビュー
- コードの品質: LGTM
- テスト: LGTM
- ドキュメント: LGTM

→ マージOK

関連用語:

• SGTM
• WIP
• PTAL

---

SGTM

定義: SGTMは「Sounds Good To Me」の略で、「良いと思います」という意味です。LGTMと似ていますが、より柔らかい表現です。

なぜ重要なのか:

• 柔らかい表現: LGTMより柔らかい表現で、承認の意思を伝えられる
• コミュニケーション: チーム内でのコミュニケーションを円滑にする

使用例:

提案された変更について:
- アプローチ: SGTM
- 実装方法: SGTM

→ 承認

関連用語:

• LGTM
• WIP

---

WIP

定義: WIPは「Work In Progress」の略で、「作業中」という意味です。まだ完成していない作業を表す際に使用されます。

なぜ重要なのか:

• 作業状況の共有: チームメンバーに作業状況を伝えられる
• 重複作業の防止: 他のメンバーが同じ作業を始めるのを防げる
• 進捗管理: プロジェクトの進捗を管理しやすくなる

使用例:

PRのタイトル: [WIP] ユーザー認証機能の実装

→ まだ作業中なので、レビュー不要

関連用語:

• LGTM
• PTAL

---

PTAL

定義: PTALは「Please Take A Look」の略で、「見てください」という意味です。コードレビューを依頼する際に使用されます。

なぜ重要なのか:

• レビューの依頼: 明確にレビューを依頼できる
• コミュニケーション: 短い表現で依頼の意思を伝えられる

使用例:

@team PTAL #123

→ チームメンバーにレビューを依頼

関連用語:

• LGTM
• WIP

---

ACK

定義: ACKは「Acknowledged」の略で、「了解しました」という意味です。メッセージや指示を理解したことを伝える際に使用されます。

なぜ重要なのか:

• 確認の意思表示: メッセージを理解したことを伝えられる
• コミュニケーション: 短い表現で確認の意思を伝えられる

使用例:

A: このタスクをお願いします
B: ACK

→ 了解したことを伝える

関連用語:

• LGTM
• SGTM

---

NACK

定義: NACKは「Negative Acknowledged」の略で、「了解できません」という意味です。提案や変更に反対する際に使用されます。

なぜ重要なのか:

• 反対の意思表示: 明確に反対の意思を伝えられる
• 建設的な議論: 反対理由を説明することで、より良い解決策を見つけられる

使用例:

提案された変更について:
- パフォーマンスの懸念: NACK
- 理由: この実装ではN+1問題が発生する可能性がある

→ 反対の意思と理由を伝える

関連用語:

• ACK
• LGTM

---

Ship It

定義: Ship Itは「出荷する」という意味で、コードを本番環境にデプロイする準備ができたことを表します。

なぜ重要なのか:

• デプロイの準備: デプロイの準備ができたことを明確に伝えられる
• チームの合意: チーム全体でデプロイに合意したことを示せる

使用例:

コードレビュー完了:
- すべてのレビュー: LGTM
- テスト: パス
- ドキュメント: 完了

→ Ship It!

関連用語:

• LGTM
• Deploy

---

Nit

定義: Nitは「Nitpick」の略で、「細かい指摘」という意味です。コードの品質には影響しないが、改善できる点を指摘する際に使用されます。

なぜ重要なのか:

• コード品質の向上: 細かい改善点を指摘できる
• 学習の機会: レビューを受ける側が学習できる
• チームの標準: チームのコーディング標準を統一できる

使用例:

Nit: 変数名をより明確にした方が良いかもしれません
例: `data` → `userData`

→ 必須ではないが、改善できる点

関連用語:

• LGTM
• Code Review

---

Block

定義: Blockは「ブロック」という意味で、コードレビューでマージを阻止する重大な問題があることを表します。

なぜ重要なのか:

• 重大な問題の指摘: マージ前に重大な問題を指摘できる
• 品質の確保: 品質の低いコードがマージされるのを防げる

使用例:

Block: セキュリティの問題があります
- SQLインジェクションの脆弱性が存在する
- 修正が必要です

→ マージ不可

関連用語:

• LGTM
• Security

---

Request Changes

定義: Request Changesは「変更を依頼する」という意味で、コードレビューで変更を依頼する際に使用されます。

なぜ重要なのか:

• 変更の依頼: 明確に変更を依頼できる
• フィードバック: 具体的なフィードバックを提供できる

使用例:

Request Changes:
- エラーハンドリングを追加してください
- テストケースを追加してください

→ 変更を依頼

関連用語:

• LGTM
• Code Review