Add help content for rule configuration
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 474
- Forks
- 65
- Avg merge
- 22h 25m
- Merged PRs (30d)
- 26
Description
Rules can define and use configuration. The configuration options may be important for the correct execution of the rule.
Currently rules that use configuration can include notes to describe how the rule can be configured. Notes are not displayed in standard output, however adding a specific section Configuration into rule help may be helpful.
Once configuration is put into a separate section it can be included in output as an additional option.
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 locating the rule help generation and the handling of configuration notes described in the issue. Trace how standard output is assembled, then verify that configuration details appear in their own help section and can be included as an additional output option.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100