プル要求を送信する方法

[アーティクル]
05/05/2022

コンテンツを変更するには、フォークからプル要求 (PR) を送信します。プル要求は、マージする前に確認する必要があります。最良の結果を得るために、プル要求を送信する前に編集チェックリストを確認してください。

Git ブランチの使用

PowerShell-Docsの既定のブランチはブランチです main 。作業ブランチで行われた変更は、公開される前に main ブランチにマージされます。ブランチは main 、平日の午後 3:00 (太平洋時間) にブランチに live マージされます。 liveブランチには、docs.microsoft.com に発行されたコンテンツが含まれています。

変更を開始する前に、PowerShell-Docs リポジトリのローカルコピーに作業ブランチを作成します。ローカルで作業する場合は、作業ブランチを作成する前に、必ずローカルリポジトリを同期してください。作業ブランチは、ブランチの最新のコピーから作成する main 必要があります。

すべてのプル要求は、main ブランチをターゲットにする必要があります。ブランチに変更を live 送信しないでください。 main ブランチで行われた変更が live にマージされ、live に対する変更が上書きされます。

プル要求プロセスをすべてのユーザーに対して効果的に機能させる

PR をよりシンプルで焦点を絞ったものにすると、レビューとマージに要する時間を短縮できます。

多数のファイルを更新したり、関連のない変更を含めたりするプル要求を避ける

関連性のない変更を含む PR を作成しないようにします。既存の記事の軽微な更新は、新しい記事や大規模な改訂から切り離します。このような変更には、別の作業ブランチで対応します。

一括変更では、多数の変更されたファイルを含む PR が作成されます。 PR の変更されたファイルを最大 50 個に制限します。大規模な PR はレビューするのが難しく、エラーを含む可能性が高くなります。

ファイル名の変更またはファイルの削除

ファイルの名前を変更または削除するときは、PR に関連する問題が発生している必要があります。そのイシューでは、ファイルの名前変更または削除の必要性について話し合う必要があります。

コンテンツの追加または変更を、ファイル名の変更やファイルの削除と一緒にしないでください。名前が変更または削除されたファイルは、グローバルリダイレクトファイルに追加する必要があります。可能な場合は、TOC ファイルを含め、名前が変更または削除されたコンテンツにリンクするファイルをすべて更新します。

Docs PR 検証サービス

Docs PR 検証サービスは、変更に対して検証規則を実行するGitHub アプリです。検証サービスによって報告されたエラーまたは警告を修正する必要があります。

動作は次のとおりです。

PR を送信します。
PR の状態を示す GitHub コメント内に、リポジトリで有効になっている "チェック" の状態が表示されます。この例では、"コミット検証" と "OpenPublishing.Build" という 2 つのチェックが有効になっています。

コミットの検証に失敗した場合でも、ビルドは検証を通過できます。
[詳細] をクリックして、詳細情報を確認します。
[詳細] ページには、失敗したすべての検証チェックと、問題を修正する方法に関する情報が表示されます。
検証が成功すると、PR に次のコメントが追加されます。