EnAccess/OpenSmartMeter

Code Refactor: Verbose variable naming

Open

#84 opened on Jul 5, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)HTML (21 forks)auto 404
firmwaregood first issue

Repository metrics

Stars
 (27 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Scan the firmware source code for abbreviated variable names like 'ind1', 'ind2', 'dt', 'c chek' and replace them with descriptive names that clarify their purpose.
Tech stack
None
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80