jaegertracing/jaeger

Enable more revive linter rules

Open

#5,506 opened on Jun 2, 2024

View on GitHub
 (25 comments) (0 reactions) (0 assignees)Go (18,974 stars) (2,326 forks)batch import
good first issuehelp wanted

Description

In #5505 we introduced a revive linter, but had to disable many of its rules because they were breaking on some places in the code. https://github.com/jaegertracing/jaeger/blob/b38d2f9bc18806b6e716f6f666a786f0aca7d912/.golangci.yml#L154

We can re-enable those rules incrementally by fixing the corresponding breaks one rule at a time (make lint should succeed) and removing the disabling entry from the config.

Strong advice: DO NOT OPEN A PR without discussing the impact of the specific linter on this issue first. We don't want very possible linter - some of them are stupid, others require a lot of code changes with minimal benefits.

Contributor guide

Tech stack
go
Domain
build systemci cddeveloper experience
Issue type
chore
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.
over 1 week
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.
mostly clear
Prerequisites
Go programmingfamiliarity with revive linterunderstanding of Jaeger codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by examining the disabled revive linter rules in the .golangci.yml file (line 154). Choose one rule, understand why it fails by running `make lint`, and propose a fix in the issue discussion. After maintainer approval, implement the fix and update the config to re enable the rule.