PowerShell / PowerShell/PSScriptAnalyzer
Provide updatable help for PSScriptAnalyzer
Open
Nobody has claimed this yet.
Area - Documentation
Consider - 2.0
Issue - Enhancement
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
From https://github.com/PowerShell/PSScriptAnalyzer/pull/1476#discussion_r420673746.
We should publish updatable help for PSScriptAnalyzer and set the URI in the manifest.
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 with the linked pull-request discussion, then inspect the module manifest and the existing help content. Determine how PSScriptAnalyzer help should be published and where the manifest URI belongs. Done means updatable help is published and the manifest points to it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100