vmware/go-vcloud-director

Clean-up code of one-letter identifiers

Aberta

#33 aberto em 17 de ago. de 2018

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Go (75 forks)auto 404
Code qualityenhancementgood first issue

Métricas do repositório

Stars
 (82 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

The whole code base is littered with identifiers (variables, struct types, and types) made of a single letter.

To make the library code more readable, and easier to maintain and expand, these identifiers must be replaced with more telling names.

The only place where single letter variables can be accepted is for a counter in a short loop.

Moreover, variables and field name vdc and vcd should be avoided as they are easily mixed up, and replaced with vcDirector and vdCenter or similarly telling names.

Guia do colaborador

Direção de pesquisa
Identifique todos os identificadores de uma única letra e proponha substituições usando convenções de nomenclatura consistentes.
Pilha de tecnologia
go
Domain
api
Tipo Issue
Refatoração
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.
1-2 dias
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.
60