アーキテクチャ変更リクエスト

アーキテクチャ変更リクエストを使用すると、構造化されたレビューワークフローを通じてC4モデルへの変更を提案できます。アーキテクチャを直接編集する代わりに、チームメンバーがレビュー、議論、マージ可能なリクエストを作成します。

仕組み

変更リクエストは、アーキテクチャモデルへの1つ以上の提案された変更をグループ化します。コードリポジトリのプルリクエストに似たライフサイクルに従います:

1. タイトルと説明を付けてリクエストを作成
2. 変更を追加 — C4要素（システム、コンテナ、コンポーネント、コード要素、リレーションシップ、オーバーレイ）の作成、更新、削除
3. 提案の準備ができたらレビューに提出
4. レビュー — チームメンバーが承認、変更要求、またはコメント
5. すべての変更をライブアーキテクチャに適用するためにマージ

リクエストのライフサイクル

各リクエストは以下のステータスを経ます:

リクエストの作成

リクエストタブから

1. プロジェクトに移動
2. リクエストタブを開く
3. 新しいリクエストをクリック
4. タイトル（最大200文字）とオプションの説明を入力
5. リクエストは下書きステータスで開始

変更の追加

下書きまたはオープンのリクエスト内で、以下を選択して変更を追加:

• 操作: 作成、更新、または削除
• 要素タイプ: システム、コンテナ、コンポーネント、コード、リレーションシップ、またはオーバーレイ
• 要素データ: 新規または変更される要素のプロパティ

変更は操作タイプ（作成、更新、削除）ごとにグループ化され、レビューしやすくなっています。

リクエストの編集

作成者はマージされていない限り、いつでもリクエストのタイトルと説明を編集できます。タイトル横の鉛筆アイコンをクリックして編集モードに入ります。

リクエストのレビュー

レビューの提出

編集アクセスを持つチームメンバーがオープンなリクエストをレビュー:

• 承認 — 提案に問題なし
• 変更要求 — マージ前に修正が必要
• コメント — 正式な判断なしにフィードバックを残す

アクティビティフィード

アクティビティタブにすべてのレビューとコメントが時系列で表示されます。下部のコメント入力欄を使って、正式なレビューなしに素早いコメントを残せます。

リクエストのマージ

リクエストがレビューされ承認されたら:

1. リクエスト詳細ページを開く
2. マージをクリック
3. すべての変更がC4モデルにアトミックに適用

編集権限を持つチームメンバーのみがリクエストをマージできます。

変更のプレビュー

プレビュータブには、変更適用後のアーキテクチャの視覚的な表現が表示され、レビュアーがマージ前に影響を理解できます。

ベストプラクティス

わかりやすいタイトルを書く

意図を説明するわかりやすいタイトルを使用:

• 「決済サービスとStripe連携の追加」
• 「モノリシックAPIをユーザーサービスと注文サービスに分割」
• 「非推奨の通知コンポーネントを削除」

リクエストを焦点を絞る

• リクエストごとに1つの論理的な変更
• 無関係な変更を混在させない
• 小さなリクエストの方がレビューしやすい

説明を活用

提案された変更の理由を説明:

• なぜこのアーキテクチャ変更が必要か
• どのような代替案が検討されたか
• 関連するADRやドキュメントへのリンク

マージ前にレビュー

• 少なくとも1件の承認を推奨
• コメントを使用してトレードオフを議論
• プレビュータブで結果を確認

次のステップ

• C4モデル概要 — アーキテクチャモデルの理解
• チーム — コラボレーションレビューのためのチーム設定
• ドキュメント — アーキテクチャの決定にADRをリンク