etcd-io/etcd

Enable `unexported-return` linter rule

Open

#18,370 opened on Jul 26, 2024

View on GitHub
 (24 comments) (0 reactions) (2 assignees)Go (10,352 forks)batch import
area/testinghelp wantedpriority/important-longtermtype/cleanup

Repository metrics

Stars
 (51,701 stars)
PR merge metrics
 (Avg merge 6d 3h) (71 merged PRs in 30d)

Description

What would you like to be added?

There are two remaining linter rules that we haven't enabled but are left as TODO (./tools/.golangci.yaml): exported and unexported-return. The former will have significant changes to exported functions and interfaces. The latter, even though it impacts exported structs, it's for the better (it exposes them without breaking client implementations).

I suggest breaking the pull requests into small tasks like we did on #17578.

The following modules have warnings to be addressed:

  • api - #18645
  • pkg
  • client/pkg
  • client/v3
  • server - #19052
  • tests
    • #19105

Refer to the attached log file with the result from KEEP_GOING_MODULE=true make verify-lint.

Why is this needed?

To improve the quality of the code.

Contributor guide

Research direction
Pick a module (e.g., pkg) from the list and run the linter locally to see the warnings. Then fix the unexported return types by exporting the necessary types or adjusting the functions.
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.
2
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
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75