etcd-io/etcd

Enable `unexported-return` linter rule

Open

#18.370 aberto em 26 de jul. de 2024

Ver no GitHub
 (24 comments) (0 reactions) (2 assignees)Go (10.352 forks)batch import
area/testinghelp wantedpriority/important-longtermtype/cleanup

Métricas do repositório

Stars
 (51.701 stars)
Métricas de merge de PR
 (Mesclagem média 6d 3h) (71 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Esta issue é uma meta issue para habilitar a regra de linter `unexported return` em vários módulos do etcd. Para contribuir, escolha um módulo com trabalho pendente (por exemplo, pkg, client/pkg, client/v3) e execute `KEEP GOING MODULE=true make verify lint` para gerar avisos. Corrija cada aviso garantindo que funções exportadas que retornam tipos não exportados exportem o tipo ou refatorizem a função. Consulte o arquivo de log anexado e o padrão estabelecido por PRs anteriores, como #18645 e #19052.
Pilha de tecnologia
go
Domain
backend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Go
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75