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
分支
415
平均合併
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 摘要。