mgechev/revive

Add a comment length checking in `rule.exported`

Open

#934 opened on Nov 7, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Go (316 forks)github user discovery
good first issuerule proposal

Repository metrics

Stars
 (5,517 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. Hello. We would like to have a comment length checking for exported types and methods on our project.

Describe the solution you'd like Add an argument for the rule for setting a minimum required comment length

Describe alternatives you've considered I seached for this functionality in other linters but didn't find anything

Contributor guide

Research direction
Examine how rule.exported currently works, then add a configuration option to specify minimum comment length and implement the check.
Tech stack
go
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
Golinter development concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45