PowerShell / PowerShell/PSScriptAnalyzer

New function: Show-RuleHelp

未关闭
#730 8 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Issue - Discussion Issue - Enhancement
主要语言
C#
星标
2.2k
派生
414
平均合并
13 小时 1 分钟
30 天内合并 PR
2

描述

I have a function to submit, Show-RuleHelp, which opens the .md file of help for each rule. Before I do a PR, I want to know if you're interested in including it and, if so, how?

-- Add the script containing the function to ScriptsToProcess
-- Add the function to PSScriptAnalyzer.psm1 + FunctionsToExport in the psd1

You can see the code at https://github.com/juneb/Development/blob/master/Show-RuleHelp.ps1.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先查看链接的 Show-RuleHelp.ps1 实现,然后检查 PSScriptAnalyzer.psm1 以及 issue 中提到的模块清单条目。确定该函数是否属于 ScriptsToProcess,以及是否应将其导出;完成标准是确定一种纳入路径,并验证生成的模块行为。

由索引模型根据 Issue 内容生成。

评估

技术栈
powershell
领域
cli, documentation
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。