Need automation to drive documentation of linter rules
Open
devdiv
story: linter rules
tech debt
- Dominant language
- Bicep
- Stars
- 3.6k
- Forks
- 830
- Avg merge
- 1d 21m
- Merged PRs (30d)
- 79
Description
The process we need:
1) if a rule exists without documentation, create a bug to provide documentation in the current sprint
2) if a rule exists which has help documentation but the aka link is not set correctly is or not enabled, create a bug to set it up (this part is currently getting overlooked, e.g. for no-conflicting-metadata)
Contributor guide
Research direction
Start by tracing how linter rules and their help or aka links are represented, then find the existing path for creating sprint bugs. Done means automation detects undocumented rules and incorrect or disabled aka links and creates the corresponding bugs.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100