プルリクエストの作成

Sentry のエンジニアリング プラクティスに従ってプルリクエストを作成します。

必須: GitHub CLI (gh) が認証され、利用可能な状態。

プロセス

ステップ 1: ブランチの状態を確認

# 現在のブランチと状態を確認
git status
git log main..HEAD --oneline

以下を確認してください:

• すべての変更がコミットされている
• ブランチがリモートに同期されている
• 必要に応じて変更が main にリベースされている

ステップ 2: 変更を分析

PR に含まれるものをレビューします:

# PR に含まれるすべてのコミットを確認
git log main..HEAD

# 完全な差分を確認
git diff main...HEAD

説明を書く前に、すべての変更の範囲と目的を理解してください。

ステップ 3: PR の説明を作成

この構造に従ってください:

<PR が何をするかの簡潔な説明>

<これらの変更が行われている理由 - モチベーション>

<検討した代替案があればその説明>

<レビュアーが必要とするその他のコンテキスト>

含めてはいけないもの:

• 「テストプラン」セクション
• テスト手順のチェックボックスリスト
• diff の冗長な要約

含めるべきもの:

• 何をなぜするかの明確な説明
• 関連する issue やチケットへのリンク
• コードから明らかでないコンテキスト
• 特に注意が必要な箇所のメモ

ステップ 4: PR を作成

gh pr create --title "<type>(<scope>): <description>" --body "$(cat <<'EOF'
<説明本文>
EOF
)"

タイトル形式 はコミット規約に従います:

• feat(scope): Add new feature
• fix(scope): Fix the bug
• ref: Refactor something

ステップ 5: レビュアーを追加 (既知の場合)

# 特定のユーザーにレビューをリクエスト
gh pr edit --add-reviewer username1,username2

# またはチームにリクエスト
gh pr edit --add-reviewer @getsentry/team-name

明確な責任を維持するために、1～3 人のレビュアーに制限してください。

PR 説明の例

機能 PR

アラート通知の Slack スレッド返信を追加

アラートが更新または解決されたときに、新しいメッセージを作成する代わりに、元の
Slack スレッドに返信を投稿するようになりました。これにより関連する通知がグループ化され、
チャネルのノイズが削減されます。

元のメッセージへの編集の投稿も検討しましたが、スレッドの方が イベントのタイムラインを
より適切に保持し、元のメッセージが Slack の編集ウィンドウより古い場合でも機能します。

Refs SENTRY-1234

バグ修正 PR

ユーザー API エンドポイントのnull レスポンスに対応

ユーザー エンドポイントはソフト削除されたアカウントに対して null を返す可能性があり、
ユーザー プロパティにアクセスするときにダッシュボード クラッシュを引き起こしていました。
これは null チェックを追加し、適切な 404 レスポンスを返します。

SENTRY-5678 を調査中に発見しました。

Fixes SENTRY-5678

リファクター PR

検証ロジックを共有モジュールに抽出

アラート、issue、プロジェクト エンドポイント全体の重複した検証コードを
共有 validator クラスに移動します。動作の変更なし。

SENTRY-9999 で新しい検証ルールを追加する際に、エンドポイント全体で
ロジックを複製しないようにします。

Issue 参照

PR 本文で issue を参照してください:

構文	効果
Fixes #1234	マージ時に GitHub issue を閉じる
Fixes SENTRY-1234	Sentry issue を閉じる
Refs GH-1234	閉じずにリンク
Refs LINEAR-ABC-123	Linear issue をリンク

ガイドライン

• 機能/修正ごとに 1 つの PR - 関連のない変更をバンドルしないこと
• PR はレビュー可能に - 小さい PR はより速く、より良いレビューが得られます
• 理由を説明する - コードは何をするかを示し、説明は理由を説明します
• WIP は早めに明示 - 早期のフィードバックのためドラフト PR を使用してください

参考資料

• Sentry Code Review Guidelines
• Sentry Commit Messages