etcd-io/etcd

Enable `unexported-return` linter rule

Offen

#18.370 geöffnet am 26.07.2024

Auf GitHub ansehenContributor Guide
 (24 Kommentare) (0 Reaktionen) (2 zugewiesene Personen)Go (10.352 Forks)batch import
area/testingcontribfesthelp wantedpriority/important-longtermtype/cleanup

Repository-Metriken

Stars
 (51.701 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 6T 3h) (71 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Dieses Issue ist ein Meta Issue, um die `unexported return` Linter Regel über mehrere Module in etcd hinweg zu aktivieren. Um beizutragen, wählen Sie ein Modul mit ausstehender Arbeit (z. B. pkg, client/pkg, client/v3) und führen Sie `KEEP GOING MODULE=true make verify lint` aus, um Warnungen zu generieren. Beheben Sie jede Warnung, indem Sie sicherstellen, dass exportierte Funktionen, die nicht exportierte Typen zurückgeben, entweder den Typ exportieren oder die Funktion umstrukturieren. Beziehen Sie sich auf die angehängte Protokolldatei und das Muster, das von früheren PRs wie #18645 und #19052 festgelegt wurde.
Tech Stack
go
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Go
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75