jlab-sensing/ENTS-node-firmware

Updated sps references to ENTS

Open

#125 opened on Aug 20, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C (7 forks)auto 404
documentationenhancementgood first issuehelp wanted

Repository metrics

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

Description

Describe the Enhancement All references of the soil power sensor should be replace. The following is a list of references off the top of my head:

  • Doxygen url and pages
  • Protobuf python module
  • Protobuf files names

Benefits

  • Readability to new users who may get confused by different names
  • More marketable name

Possible Drawbacks N/A

Additional Context The repo name has already been updated along with the main README a tmp fix. When creating the new python package use the name ents. It is amazingly currently available.

Contributor guide

Research direction
Identify all occurrences of 'sps' (case sensitive) in the repository, excluding the main README and repo name which have already been updated. Use grep to find references in Doxygen configuration, protobuf file names, and Python module code. Replace each occurrence with 'ENTS', update file names and imports accordingly. Verify no remaining references by running a final grep.
Tech stack
cpython
Domain
embedded iot
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.
1-3 hours
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