EnAccess/OpenSmartMeter

Code Refactor: Verbose variable naming

Aberta

#84 aberto em 5 de jul. de 2023

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)HTML (21 forks)auto 404
firmwaregood first issue

Métricas do repositório

Stars
 (27 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

The firmware source code uses a lot of abbreviated variable names, which are not immediately clear to the reader what they stand for. Few examples are, ind1, ind2, dt, c_chek.

Use verbose naming of variables to make the code structure easier to follow.

Guia do colaborador

Direção de pesquisa
Examine o código fonte do firmware para nomes de variáveis abreviados como 'ind1', 'ind2', 'dt', 'c chek' e substitua os por nomes descritivos que esclareçam seu propósito.
Pilha de tecnologia
None
Domain
backend
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.
Menos de 1 hora
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80