プル要求の管理

2025-05-20

この記事では、PowerShell-Docs リポジトリでプル要求を管理する方法について説明します。この記事は、PowerShell-Docs チームのメンバーの仕事支援として設計されています。この情報は、パブリックコントリビューターにプロセスの透明性を提供するためにここに公開されます。

ベストプラクティス

レビューを要求します。 PR を送信するユーザーは、ピアレビューなしで PR をマージしないでください。
PR の送信時にピアレビュー担当者を割り当てます。早期割り当てにより、校閲者は編集上のコメントですぐに応答できます。
コメントを使用して、送信される変更の性質を説明します。たとえば、変更が軽微な場合は、変更を説明し、完全な技術レビューは必要ありません。必ず校閲者を @mention してください。
コメント候補機能を使用して、作成者が提案された変更を簡単に受け入れるようにします。詳細については、プル要求で提案された変更の確認を参照してください。

PR プロセスの手順

ライター: PR を制作する
- PR テンプレートに入力する
- PR によって解決された問題をリンクする
- GitHub の autoclose 機能を使用して問題を終了する
- チェックリストの各項目を調べて確認する
著者: ピアレビュー担当者を割り当てる
校閲者: 校正とコメント (必要に応じて)
ライター: レビューフィードバックを組み込む
両方: プレビューレンダリングを確認する
両方: 検証レポートを確認する - 警告とエラーを修正する
校閲者: マークレビュー "承認済み"
Repo Maintainer: マージ PR

コンテンツレビュー担当者チェックリスト

より包括的なリストについては、編集チェックリストを参照してください。

文法、スタイル、簡潔さ、技術的な正確さを校正する。
ターゲットバージョンに対して引き続き例が適用されていることを確認する
プレビューレンダリングを確認する
メタデータの確認 - ms.date、ms.assetid の削除、必須フィールドの確認
マークダウンの正確性を検証する
- コンテンツ固有の書式設定ルールについては、スタイルガイドを参照してください
次のように例を再構成します。
- イントロダクションの段落
- コードと出力
- コードの詳細な説明 (必要に応じて)
ハイパーリンクの精度を確認する
- TechNet/MSDN リンクの置換または削除
- ターゲットへのリダイレクトの最小数を確認する
- HTTPS を確認する
- 正しいリンクの種類
  - ローカルファイルリンク
  - ドキュメントセットの外部にあるファイルの URL リンク
- URL からロケールを削除する
- を指す URL を簡略化する learn.microsoft.com
バージョン管理されたコンテンツがすべてのバージョンで正しいことを確認する
- バージョン管理されたコンテンツ変更レポートを確認してください

ブランチマージプロセス

mainブランチは、liveにマージする必要がある唯一のブランチです。有効期間が短い (作業中の) ブランチからのマージは、 mainにマージする前にスカッシュする必要があります。

元にマージ/先にマージ	リリースブランチ（release-branch）	メイン	生きる
作業ブランチ	スカッシュとマージ	スカッシュとマージ	許可されていない
リリースブランチ（release-branch）	—	マージ	許可されていない
メイン	リベース	—	マージ

PR 合併チェックリスト

コンテンツレビューの完了
変更の正しいターゲットブランチを選ぶ
マージ競合はありません
すべての検証とビルドステップが通過しました。
- 警告と提案は修正する必要があります (例外については「メモ」を参照してください)
- リンクが壊れていない
- チェックリストアクションが実行され、渡されました
- 承認チェックがトリガーされた場合は、通過しました。
テーブルに従いマージする

注記

次の警告は無視できます。

Can't find service name for `<version>/<modulepath>/About/About.md`

Metadata with following name(s) are not allowed to be set in YAML header, or as file level
metadata in docfx.json, or as global metadata in docfx.json: `locale`. They are generated by
Docs platform, so the values set in these 3 places will be ignored. Please remove them from all
3 places to resolve the warning.

PR がマージされると、ターゲットブランチの HEAD が変更されます。以前の HEAD に基づくオープン PR はすべて古くなっています。メンテナには、マージの警告をオーバーライドし、GitHub で古い PR をマージするために必要な権限があります。以前にマージされた PR が同じファイルに触れなかった場合、古い PR のマージは安全です。

PR を更新するには、[ブランチの更新 ] ボタンを選択します。 「リベースで更新」オプションを選択します。詳細については、「 pull request ブランチの更新」を参照してください。

ライブへの公開

定期的に、 main ブランチに蓄積された変更をライブ Web サイトに公開する必要があります。

mainブランチは、各平日の午後 3 時 PST にliveにマージされます。
mainブランチは、大幅な変更後にliveにマージする必要があります。
- 50 個以上のファイルに対する変更
- リリースブランチをマージした後
- リポジトリまたはドキュメントセット構成の変更 (docfx.json、OPS 構成、ビルドスクリプトなど)
- リダイレクトファイルの変更
- TOC の変更
- 「プロジェクト」ブランチをマージした後（コンテンツの再編成、一括更新など）

次の方法で共有