linkedin / linkedin/Burrow

Enable recommended default modules for golintci/revive

Open
#808 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
4k
Forks
818
Avg merge
1h 14m
Merged PRs (30d)
1

Description

Golintci now contains an updated version of revive that has an updated default rule list that aligns with their recommended configuration. See https://github.com/mgechev/revive/pull/799 for details.

Two of the newly recommended rules fail on the current code tree with what seem to be legitimate complaints. I disabled these rules to get the CI unblocked on go 1.21.x for this issue https://github.com/linkedin/Burrow/issues/806. It would probably be worthwhile to re-enable these rules and update the code to pass.

https://github.com/linkedin/Burrow/blob/master/.golangci.yml#L48
https://github.com/linkedin/Burrow/blob/master/.golangci.yml#L61

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect .golangci.yml at the two linked configuration lines and review the related issue about Go 1.21.x CI. Re-enable the two disabled recommended rules, identify the current code complaints, and update the code until the lint checks pass. Done means the recommended modules are enabled and CI is no longer blocked by their findings.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
ci-cd, tooling
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.