OpenwaterHealth / OpenwaterHealth/openlifu-python
Improve organization of global status variables
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 27
- Forks
- 21
- Avg merge
- 1d 20m
- Merged PRs (30d)
- 6
Description
Lots of magic numbers relating to hardware statuses are defined as globals which can be cumbersome to reference in relation to the particular function of the status variables. For readability and maintainability, those should be packed into enums.
Traceability Information:
- Issue: OpenLIFU-python#228
- SOFTREQ: OpenLIFU-python#337
- Comment: This issue is related to the requirements defined in OpenLIFU-python#337.
This information was populated automatically by a script on 2025-06-09T18:02:24Z.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files or tests. Locate the global hardware-status constants and their references, group related values into enums, and verify that existing status handling still uses the same values and remains readable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- embedded-iot
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100