ドラフトコミットとは?
ドラフトコミットを使うと、変更がアクティブなブランチにコミットされる 前 にフィードバックをリクエストできます。コミットしていないワークスペースの変更から直接レビューを作成できます。 これにより、必要なコードレビューを受けつつ、コミット履歴をきれいに保つことができます。なぜドラフトコミットを使うのか?
ドラフトコミットは、次のような場合に最適です:- 単一ブランチで作業 し、よりシンプルなレビューワークフローが欲しい
- 確定させる前に、進行中の変更に対して 早期フィードバック が欲しい
- 承認された変更のみをコミットして、履歴をきれいに保つ
- アイデアを試し、恒久的にする前にチームの意見が欲しい
ドラフトコミット vs レビュー
適切なワークフローを選ぶための簡単な比較です:
どちらの機能も、コメント、承認、通知を備えた同じレビュー体験を作成します。主な違いは、変更を いつ コミットするか — フィードバックを得る前か後か — です。
ドラフトコミットの作成
ステップバイステップの手順:-
ワークスペースで変更を加える
- 通常どおりファイルを編集します
- 変更はワークスペースにコミットされないままです
-
リポジトリを開く
- Diversion Web アプリでリポジトリを開きます
- ワークスペースの保留中の変更は Files ビューに表示されます
-
「Commit…」の隣のドロップダウン矢印をクリック
- コミットボタンの右側にはドロップダウン矢印 (▼) があります
- 矢印をクリックしてドロップダウンメニューを開きます
- 「Send to review…」 を選択します
- 送信するファイルを確認
- レビューに送信されるファイルを示す確認ダイアログが表示されます
- ファイルリストを確認し、「Send to review」 をクリックして続行します
-
レビューの詳細を記入
- Title (必須): 変更の簡単な説明
- 例: 「Add user authentication endpoints」
- Description (オプション): レビュアー向けの詳細な説明
- 何を変更し、なぜかを説明します
- 特にフィードバックが欲しい箇所があれば言及します
- Reviewers (オプション): 変更をレビューすべきチームメイトを選択
- レビュアーは今追加することも後で追加することもできます
- Title (必須): 変更の簡単な説明
-
「Send to Review」をクリック
- コミットされていない変更でレビューが自動的に作成されます
- ワークスペースは自動的にクリアされるので、すぐに他の変更に着手できます (変更はドラフトに安全に保存されています)
- アサインされたレビュアーにメール通知が送信されます
ドラフトコミットの管理
ドラフトの表示
-
ブランチセレクターを開く
- ブランチセレクター (左上、現在のブランチとコミットを表示) を開き、Drafts タブをクリックします。
-
ドラフトを見つける
- ドラフトコミットは Drafts タブに表示されます
- 各ドラフトはタイトルとソースブランチを表示します
-
ドラフトアクションにアクセス
- ドラフトの隣にある … (その他のオプション) メニューをクリックして、利用可能なアクションを確認します:
- View Review: フィードバックとコメントを見るために関連レビューを開く
- Update: ドラフトに切り替えて作業を続行する
- Close: ドラフトコミットを破棄する
- ドラフトの隣にある … (その他のオプション) メニューをクリックして、利用可能なアクションを確認します:
ドラフトコミットの更新
作成後にドラフトを変更する必要がある場合: ステップバイステップの手順:-
ドラフトを見つける
- ブランチセレクターを開き、Drafts タブに切り替えます。リストからドラフトを見つけます。
-
「Update」をクリック
- ドラフトの隣の … (その他のオプション) メニューをクリックします
- メニューから 「Update」 を選択します
- ダイアログで 「Switch to draft」 をクリックして確認します
- これによりワークスペースがドラフトブランチに切り替わり、ドラフトの変更が読み込まれます
- 編集を続行できます
-
追加の変更を加える
- レビュアーのフィードバックに対応するためにファイルを編集します
-
ドラフトを更新
- 変更をコミットします
- レビューは自動的に新しい変更で更新されます
- レビュアーには更新された差分が表示されます
レビュー承認後
レビュアーがドラフトを承認したら:-
フィードバックを確認
- すべてのコメントと承認を読み通します
- すべての懸念事項が対処されていることを確認します
-
変更を確定
- 必要に応じてドラフトに戻って最終調整を行います
- すべてがコミット準備完了であることを確認します
-
変更をコミット
- 承認された変更をブランチにコミットできるようになりました
- レビューされ承認された変更のみでコミット履歴がきれいに保たれます
-
ドラフトは自動的に閉じられる
- マージまたはコミットされると、ドラフトのステータスは closed に変わります
ドラフトコミットのクローズ
ドラフトを進めないと決めた場合: ステップバイステップの手順:-
ドラフトを見つける
- ブランチセレクターを開き、Drafts タブに切り替えます。リストからドラフトを見つけます。
-
「Close」をクリック
- ドラフトの隣の … (その他のオプション) メニューをクリックします
- メニューから 「Close」 を選択します
-
クローズを確認
- 確認ダイアログで 「Close draft」 をクリックします
- このアクションは取り消せません
-
ドラフトが削除される
- ドラフトはアクティブなドラフトリストから削除されます
- ドラフトブランチにいた場合は、ソースブランチに戻ります
- 変更は破棄されます
ドラフトレビューの操作
レビュープロセス
ドラフトコミットはレビューを自動的に作成するので、レビュープロセスは同じように機能します:- レビュアーは特定の行またはファイルにコメント できます
- レビュアーは承認または変更をリクエスト できます
- レビュアーが応答すると 通知を受け取ります
- 通常のレビューと同様にレビュー内で議論 が行われます
通知
以下について、メール通知を受け取ります:- レビュアーがドラフトにコメントしたとき
- レビュアーが承認または変更をリクエストしたとき
- レビューがクローズ/マージされたとき