EnAccess/OpenSmartMeter

Code Refactor: Verbose variable naming

Offen

#84 geöffnet am 05.07.2023

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)HTML (21 Forks)auto 404
firmwaregood first issue

Repository-Metriken

Stars
 (27 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Durchsuchen Sie den Firmware Quellcode nach abgekürzten Variablennamen wie 'ind1', 'ind2', 'dt', 'c chek' und ersetzen Sie diese durch beschreibende Namen, die ihren Zweck verdeutlichen.
Tech Stack
Keine
Domain
backend
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80