EnAccess/OpenSmartMeter

Code Refactor: Verbose variable naming

Aperta

#84 aperta il 5 lug 2023

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)HTML (21 fork)auto 404
firmwaregood first issue

Metriche repository

Star
 (27 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Scansiona il codice sorgente del firmware per variabili con nomi abbreviati come 'ind1', 'ind2', 'dt', 'c chek' e sostituiscili con nomi descrittivi che ne chiariscano lo scopo.
Tech stack
Nessuno
Dominio
backend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80