为 PowerShell 文档做出贡献

感谢您对PowerShell的支持！

贡献者指南是一系列文章的集合，描述了我们在 Microsoft 用于创建文档的工具和流程。其中一些指南涵盖了发布到 learn.microsoft.com 的任何文档集的通用信息。其他指南特定于我们如何编写 PowerShell 文档。

常见文章可在我们集中的贡献者指南中找到。 PowerShell 特定指南可在此处获取。

贡献方式

有两种贡献方式。这两项贡献对我们都很有价值。

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

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

准备做出贡献

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

1. 注册 GitHub
2. 安装 Git 和 Markdown 工具
3. 安装文档创作包
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 基金会行为准则。有关更多信息，请参阅行为准则常见问题解答。

后续步骤

以下文章涵盖特定于 PowerShell 文档的信息。如果与集中式贡献者指南中的指南有重叠，我们会指出这些规则对于 PowerShell 内容有何不同。

查看以下文件：

• 开始编写文档
• Markdown 最佳实践
• PowerShell-文档风格指南
• 如何提交问题
• 提交拉取请求

其他资源

• 编辑清单
• 我们如何管理问题
• 我们如何管理拉取请求