PowerShell / PowerShell/PSScriptAnalyzer

Add suggestion to read About_TOPIC files to Script Analyzer rules

未关闭
#575 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

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

描述

When you have a Rule run for example the PSUseOutputTypeCorrectly I would suggest adding in information to the rule Output to the user to check any possible corresponding About_help Topic for information on how to mitigate the rule being flagged.

@juneb - What do you think to this idea?

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先查看 PSUseOutputTypeCorrectly 规则输出以及相应的 About_TOPIC 帮助指南。确定适用的规则消息如何将用户引导至缓解措施信息,并考虑其他可能具有对应 topics 的 Script Analyzer 规则。相关规则的输出能够一致地将用户指向适当的指南,即表示完成。

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

评估

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

把新 issue 发到你的邮箱

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