etcd-io/etcd

Enable `unexported-return` linter rule

Open

#18.370 aperta il 26 lug 2024

Vedi su GitHub
 (24 commenti) (0 reazioni) (2 assegnatari)Go (10.352 fork)batch import
area/testinghelp wantedpriority/important-longtermtype/cleanup

Metriche repository

Star
 (51.701 star)
Metriche merge PR
 (Merge medio 6g 3h) (71 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Questo problema è un meta problema per abilitare la regola del linter `unexported return` in più moduli di etcd. Per contribuire, scegli un modulo con lavoro in sospeso (ad es. pkg, client/pkg, client/v3) ed esegui `KEEP GOING MODULE=true make verify lint` per generare avvisi. Correggi ogni avviso assicurandoti che le funzioni esportate che restituiscono tipi non esportati esportino il tipo o rifattorizzino la funzione. Fai riferimento al file di log allegato e allo schema stabilito dalle PR precedenti come #18645 e #19052.
Tech stack
go
Dominio
backend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75