贡献于 PowerShell 文档

感谢你对 PowerShell 的支持!

参与者指南是一系列文章,介绍我们在Microsoft创建文档时使用的工具和过程。 其中一些指南涵盖了发布到learn.microsoft.com的文档集中通常包含的信息。 其他指南特定于如何编写 PowerShell 文档。

我们的集中 参与者指南中提供了常见文章。 此处提供了特定于 PowerShell 的指南。

参与方式

有两种方法可以参与。 这两个贡献对我们很有价值。

  • 归档问题 有助于我们识别文档中的问题和差距。 有时,这些问题难以解决,需要更多的调查和研究。 问题过程使我们能够就问题进行对话,并制定令人满意的解决方案。

  • 提交拉取请求 以添加或更改内容是一个更相关的过程。 以下信息概述了将内容提交到文档的工具、流程和标准。

准备好做出贡献

贡献文档需要 GitHub 帐户。 使用以下清单安装和配置您需要用来贡献的工具。

  1. 注册 GitHub
  2. 安装 Git 和 Markdown 工具
  3. 安装 Docs 文档编辑工具包
  4. 安装 Posh-Git - 不需要但建议
  5. 设置本地 Git 存储库
  6. 查看 Git 和 GitHub 基础知识

开始编写代码

可通过两种方法为文档提供更改:

  1. 快速编辑现有文档 - 轻微更正、修复拼写错误或小添加
  2. 文档的完整 GitHub 工作流 - 大量更改、多个版本、添加或更改图像、或贡献新文章

此外,请阅读统一的贡献者指南的 “写作基础” 部分。 另一个优秀的资源是 Microsoft写作风格指南

learn.microsoft.com 使用条款涵盖了对公共存储库中的文档和代码示例的轻微更正或说明。

进行重大更改时,请使用完整的 GitHub 工作流。 如果你不是Microsoft的员工,我们的 PR 验证系统会向拉取请求添加注释,要求你签署在线贡献许可协议(CLA)。 必须先完成此步骤,我们才能查看或接受您的拉取请求。 只有在首次在存储库中提交 PR 时,才需要对 CLA 进行签名。 每次参与新存储库时,系统都可能会要求你对 CLA 进行签名。

行为准则

发布到 Microsoft Learn 的所有存储库都遵循 Microsoft开源行为准则.NET Foundation 行为准则。 有关详细信息,请参阅 行为准则常见问题解答

后续步骤

以下文章介绍特定于 PowerShell 文档的信息。 如果集中参与者指南中存在与指南的重叠,我们将说明这些规则对 PowerShell 内容有何不同。

请参阅以下文档:

其他资源