PowerShell / PowerShell/PSScriptAnalyzer
Properly document PSSA2
Open
Nobody has claimed this yet.
Consider - 2.0
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
PSSA2 should have full documentation. This includes:
- Descriptive code comments that can be used to provide API documentation for consumers
- Documentation of all rules
- Documentation of configuration and how to configure and run for users
- Documentation on rule suppression
- Documentation on hosting
- Documentation on implementing a rule in both .NET and PS script
- Documentation on the project's architecture
- A full README on how to build, run and contribute
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 inventorying the project's rules, configuration and suppression behavior, hosting model, architecture, and existing README. Review the .NET and PowerShell rule implementation paths to identify the API comments and examples that need documentation. Done means the README, user and contributor setup, rule reference, configuration, suppression, hosting, architecture, and rule-authoring documentation are complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100