mgechev / mgechev/codelyzer

[Feature Request] Docs should mention defaults

Open
#802 2 comments 3 reactions 0 assignees View on GitHub
help wanted
Dominant language
TypeScript
Stars
2.5k
Forks
232
PR merge metrics
No merged PRs in 30d

Description

The docs pages for the rules should mention each rule's default.

Otherwise the only way to know is to inspect the code.

Contributor guide

Open the contributing guide

Research direction

Locate the documentation pages for the rules and review how each rule is currently described. Add the default value for every rule, then check the rendered pages or documentation checks to confirm each rule has a default documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.