EnAccess/OpenSmartMeter

Code Refactor: Verbose variable naming

Ouverte

#84 ouverte le 5 juil. 2023

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)HTML (21 forks)auto 404
firmwaregood first issue

Métriques du dépôt

Stars
 (27 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Parcourez le code source du firmware pour les noms de variables abrégés comme 'ind1', 'ind2', 'dt', 'c chek' et remplacez les par des noms descriptifs qui clarifient leur objectif.
Stack technique
Aucun
Domaine
backend
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80