如何提交拉取请求

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

使用 git 分支

PowerShell-Docs 的默认分支是 main 分支。 在发布之前,在工作分支中所做的更改将合并到 main 分支中。 该 main 分支每个工作日在下午 3:00(太平洋时间)合并到 live 分支中。 分支 live 包含发布到 learn.microsoft.com的内容。

在开始任何更改之前,请在 PowerShell-Docs 存储库的本地副本中创建工作分支。 在本地工作时,在创建工作分支之前,请务必同步本地存储库。 工作分支应该从 main 分支的 up-to日期版本副本创建。

所有拉取请求都应以 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 内容中。 它的外观如下所示:

# 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 正在进行中,请将其设置为 草稿模式 或将 PR 标题 WIP作为前缀。

期望注释

提交 PR 后,机器人将在上面发表评论。 评论提供了资源,并为后续过程设定了预期。 我们可能会定期更新此批注,因此请始终查看批注,即使这不是你的第一个贡献。

示例预期注释

Docs PR 验证服务

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

以下步骤概述了验证行为:

  1. 提交 PR。

  2. 在 GitHub 评论中,显示在存储库上启用的“检查”状态。 在此示例中,已启用两个检查:“提交验证”和“OpenPublishing.Build”:

    验证状态 - 某些检查失败

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

  3. 有关详细信息,请选择“ 详细信息 ”。 “ 详细信息 ”页显示失败的所有验证检查,并包含有关如何解决问题的信息。

  4. 验证成功后,以下注释将添加到 PR:

    验证状态:成功

注释

如果你是外部参与者(不是Microsoft员工),则你无权访问详细的生成报告或预览链接。

查看 PR 后,系统可能会要求你进行更改或修复验证警告消息。 PowerShell-Docs 团队可以帮助你了解验证错误和编辑要求。

GitHub 操作

针对更改运行多个不同的 GitHub Actions 来验证和提供上下文供你和审阅者使用。

清单验证

如果你的 PR 既不在 草稿模式,也没有以 WIP 作为前缀,GitHub Action 会检查你的 PR,确保你在 PR 模板的清单中选中了所有项目。 在完成清单之前,维护人员不会查看或合并 PR。 清单项是必需的。

授权验证

如果你的 PR 目标是 live 分支,或者修改了任何存储库配置文件,GitHub Action 会检查你的权限,以验证你是否有权提交这些更改。

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

版本化内容更改报告

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

此报告可以显示是否需要在此 PR 中更新的其他文件版本。

若要查找 PR 的版本控制内容报表,请执行以下作:

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

含版本的内容更改报告示例

后续步骤

PowerShell-Docs 样式指南

其他资源

如何管理拉取请求