etcd-io/etcd

Enable `unexported-return` linter rule

Open

#18 370 ouverte le 26 juil. 2024

Voir sur GitHub
 (24 commentaires) (0 réactions) (2 assignés)Go (10 352 forks)batch import
area/testinghelp wantedpriority/important-longtermtype/cleanup

Métriques du dépôt

Stars
 (51 701 stars)
Métriques de merge PR
 (Merge moyen 6j 3h) (71 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Ce problème est un méta problème pour activer la règle de linter `unexported return` dans plusieurs modules d'etcd. Pour contribuer, choisissez un module avec des travaux en attente (par exemple, pkg, client/pkg, client/v3) et exécutez `KEEP GOING MODULE=true make verify lint` pour générer des avertissements. Corrigez chaque avertissement en veillant à ce que les fonctions exportées qui renvoient des types non exportés exportent le type ou refactorisent la fonction. Reportez vous au fichier journal joint et au modèle établi par les PR précédentes comme #18645 et #19052.
Stack technique
go
Domaine
backend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Go
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75