mgechev/codelyzer

[Feature Request] Docs should mention defaults

Open

#802 opened on Mar 25, 2019

View on GitHubContributor guide
 (2 comments) (3 reactions) (0 assignees)TypeScript (235 forks)github user discovery
help wanted

Repository metrics

Stars
 (2,468 stars)
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

Research direction
Examine the rule implementation in the source code to extract the default value for each rule, then update the corresponding documentation page to include that default.
Tech stack
typescript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Angular
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85