PowerShell Gallery 成功的秘诀

我最近对 PowerShell Gallery 想了很多。 Microsoft 无法在 PowerShell 中提供您可能想要的一切。即使可以，PowerShell 的大小也会达到千兆字节。事实上，微软将贡献核心引擎和 cmdlet 集。但解决特定任务的PowerShell管理引擎的应用程序将留给PowerShell社区。这些解决方案可以在 PowerShell Gallery 中发布。我相信您的 PowerShell 配置工作流程应该是：

• 安装最新版本的 PowerShell
• 更新帮助
• 安装最新版本的 PowerShellGet 模块
• 从 PowerShell 模块安装经过测试、批准并满足您的业务需求的其他模块。

但本文是针对 PowerShell 模块作者的，他们投入了大量时间（通常是自己的时间）来开发、测试和支持基于 PowerShell 的解决方案。经过所有这些努力后，请与社区分享您的项目并将其发布到 PowerShell 库。虽然这不是必需的，但很高兴我们的努力得到验证，这包括看到下载计数的上升。

为了提高人们对 PowerShell 库中内容的认识，我开始托管一系列报告，包括最近发布的模块。我一直在查看报告和模块，并意识到您可以采取一些步骤来增加您宝宝的安装几率。

模块说明

在您的模块清单中，有一个描述部分。用它。如果我看不到有意义的描述，我就不太可能采用你的代码。

当我查看 PSGalleryReport 存储库中的报告时，描述非常有帮助。在浏览其他模块时，我意识到描述可能不仅仅是几句话。不要将其视为抽象。写一个有意义的描述。我认识到我需要更新我的模块描述。

公共存储库

除非专有代码元素，您的模块应该有一个公共存储库。该存储库应包含在模块的 PrivateData 部分中。我认为这是一个要求，特别是当模块作者不是公司实体时。如果 Pat PowerShell 将模块发布到 PowerShell Gallery，并且没有公共存储库；我不太可能安装该模块。如果没有公共存储库，我无法衡量代码的质量。

完整的自述文件

我强烈鼓励您在存储库中拥有完整的自述文件。该文件是您的主要“营销”工具。有效的自述文件将向我展示该模块的用途以及如何使用它。几乎没有文本的文件是一个危险信号，我应该继续处理。要么该模块尚未准备好广泛使用，要么作者所做的工作量最少。如果是这样的话，我就会怀疑他们代码的质量。一个好的自述文件是一个专业项目的标志，也是我可能会进一步研究的东西。基于最近发布的一些模块，请查看 https://github.com/chris-peterson/pwsh-gitlab 和 https://github.com/junecastillote/MS365HealthReport 以获取有效的 README 文件。良好的文档是模块成熟的标志，而 README 文件是第一个开始的地方。

遵循命名约定

成功秘诀的要素是遵循可接受的 PowerShell 命令命名约定。如果我查看你的代码，我会看到像这样公开导出的模块命令：

• 起床时间
• 运行-文件-清理
• 设置开始时间
• 执行远程关闭

我不太可能相信你的工作。动词-名词命名约定是广泛采用和广泛接受的社区标准。如果您要发布包含这些类型命令的模块，这会让我质疑您其余工作的质量。

顺便说一句，对于那些仍在学习编写 PowerShell 函数和模块的人来说，这些将是首选名称。

• 起床时间
• 调用文件清理
• 设置开始时间
• 启动-远程关机

概括

我们需要社区成员将高质量的模块发布到 PowerShell Gallery。我希望看到您成功并因您的努力而得到认可。我相信，如果您牢记这些建议，您的道路将会顺利。

对于我们所有人来说，我们需要传播我们认为无价的模块。 PowerShell Gallery 没有营销预算。这取决于社区。