如何提交拉取请求

要更改内容，请从您的分支提交拉取请求 (PR)。合并请求之前必须先对其进行审核。为了获得最佳结果，请在提交拉取请求之前查看编辑清单。

使用 git 分支

PowerShell-Docs 的默认分支是 main 分支。在工作分支中所做的更改会先合并到 main 分支中，然后再发布。 main 分支会在每个工作日下午 3:00（太平洋时间）合并到 live 分支。 live 分支包含发布到 learn.microsoft.com 的内容。

在开始任何更改之前，请在 PowerShell-Docs 存储库的本地副本中创建一个工作分支。在本地工作时，请确保在创建工作分支之前同步本地存储库。工作分支应从 main 分支的最新副本创建。

所有拉取请求都应针对 main 分支。不要将更改提交到 live 分支。在 main 分支中所做的更改将合并到 live 中，覆盖对 live 所做的任何更改。

让拉取请求流程更好地为每个人服务

您的 PR 越简单、越集中，审核和合并的速度就越快。

避免更新大量文件或包含不相关更改的拉取请求

避免创建包含不相关更改的 PR。将现有文章的小更新与新文章或主要重写分开。在单独的工作分支中处理这些更改。

批量更改会创建包含大量更改文件的 PR。将您的 PR 限制为最多 50 个已更改的文件。大型 PR 难以审查，并且更容易包含错误。

重命名或删除文件

重命名或删除文件时，一定存在与 PR 相关的问题。该问题必须讨论重命名或删除文件的需要。

避免将内容添加或更改与文件重命名和删除混合在一起。任何重命名或删除的文件都必须添加到全局重定向文件中。如果可能，请更新链接到重命名或删除内容的任何文件，包括任何 TOC 文件。

避免编辑存储库配置文件

避免修改存储库配置文件。尽可能限制对 Markdown 内容文件和内容所需的任何支持图像文件的更改。

对存储库配置文件的错误修改可能会破坏构建、引入漏洞或可访问性问题，或者违反组织标准。存储库配置文件是与以下一种或多种模式匹配的任何文件：

*.yml

.github/**

.localization-config

.openpublishing*

LICENSE*

reference/docfx.json

reference/mapping/**

tests/**

ThirdPartyNotices

tools/**

为了安全起见，如果您认为自己发现了存储库配置文件的错误或潜在的改进，请提出问题。维护人员将根据需要审查并实施任何修复或改进。

使用公关模板

当您创建 PR 时，模板会自动插入到 PR 正文中。它看起来像这样：

# PR Summary

<!--
    Delete this comment block and summarize your changes and list
    related issues here. For example:

    This changes fixes problem X in the documentation for Y.

    - Fixes #1234
    - Resolves #1235
-->

## PR Checklist

<!--
    These items are mandatory. For your PR to be reviewed and merged,
    ensure you have followed these steps. As you complete the steps,
    check each box by replacing the space between the brackets with an
    x or by clicking on the box in the UI after your PR is submitted.
-->

- [ ] **Descriptive Title:** This PR's title is a synopsis of the changes it proposes.
- [ ] **Summary:** This PR's summary describes the scope and intent of the change.
- [ ] **Contributor's Guide:** I have read the [contributors guide][contrib].
- [ ] **Style:** This PR adheres to the [style guide][style].

<!--
    If your PR is a work in progress, please mark it as a draft or
    prefix it with "(WIP)" or "WIP:"

    This helps us understand whether or not your PR is ready to review.
-->

[contrib]: /powershell/scripting/community/contributing/overview
[style]: /powershell/scripting/community/contributing/powershell-style-guide

在“PR 摘要”部分中，编写更改的简短摘要，并按问题编号列出所有相关问题，例如 #1234。如果您的 PR 修复或解决了问题，请使用 GitHub 的自动关闭功能，以便在合并您的 PR 时自动关闭问题。

查看“公关清单”部分中的项目，并在完成每一项后将其勾选。您必须遵循说明并检查每个项目，以便团队批准您的 PR。

如果您的 PR 正在开发中，请将其设置为草稿模式或在 PR 标题前添加 WIP。

期望 评论

提交 PR 后，机器人将对您的 PR 发表评论，为您提供资源并设定对其余流程的期望。即使您以前曾贡献过，请务必查看此评论，因为它包含准确且最新的信息。

文档 PR 验证服务

Docs PR 验证服务是一个 GitHub 应用程序，可对您的更改运行验证规则。您必须修复验证服务报告的任何错误或警告。

您将看到以下行为：

1. 您提交 PR。

2. 在指示 PR 状态的 GitHub 评论中，您将看到存储库上启用的“检查”状态。在此示例中，启用了两项检查：“Commit Validation”和“OpenPublishing.Build”：

   

   即使提交验证失败，构建也可以通过。

3. 单击详细信息了解更多信息。

4. 在“详细信息”页面上，您将看到所有失败的验证检查，以及有关如何解决问题的信息。

5. 验证成功后，PR 中将添加以下注释：

   

笔记

如果您是外部（非 Microsoft 员工）贡献者，您无权访问详细的构建报告或预览链接。

审核 PR 时，可能会要求您进行更改或修复验证警告消息。 PowerShell-Docs 团队可以帮助您了解验证错误和编辑要求。

GitHub 操作

多个不同的 GitHub Actions 针对您的更改运行，以验证并为您和审阅者提供上下文。

检查清单验证

如果您的 PR 未处于草稿模式并且没有以 WIP 为前缀，则 GitHub Action 会检查您的 PR 以验证您是否已检查 PR 模板清单中的每一项。如果此检查失败，团队将不会审核或合并您的 PR。检查表项目是强制性的。

授权验证

如果您的 PR 针对 live 分支或修改任何存储库配置文件，GitHub 操作会检查您的权限以验证您是否有权提交这些更改。

只有存储库管理员有权定位 live 分支或修改存储库配置文件。

版本化内容变更报告

如果您的 PR 添加、删除或修改任何版本化内容，GitHub Action 会分析您的更改并编写一份报告，总结对版本化内容所做的更改类型。

此报告可用于查看您修改的文件是否有其他版本以及这些版本是否也在变更集中进行了更新。

要查找您的 PR 的版本化内容报告：

1. 选择 PR 页面上的“检查”选项卡。
2. 从作业列表中选择“报告”作业。
3. 选择右上角的“...”按钮。
4. 选择“查看工作摘要”。

后续步骤

PowerShell-文档风格指南

其他资源

我们如何管理拉取请求