PowerShell / PowerShell/PSScriptAnalyzer
Add suggestion to read About_TOPIC files to Script Analyzer rules
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
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?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the PSUseOutputTypeCorrectly rule output and the corresponding About_TOPIC help guidance. Determine how applicable rule messages could direct users to mitigation information, and consider the other Script Analyzer rules that may have corresponding topics. Done means the relevant rule output consistently points users to the appropriate guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100