AerospaceNU/better-engine-control-software

Make a global `ICommBoundary` variable for communication

Open

#14 opened on Sep 27, 2023

View on GitHub
 (0 comments) (0 reactions) (2 assignees)C++ (2 forks)auto 404
enhancementhelp wantedquestion

Repository metrics

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

Description

In hindsight, I think it's best to prioritize the convenience of easy telemetry over cleanly modular design.

The core issue is that I think telemetry should be just as easy as printing to std::cout, just include and you can write your call. Currently, we have to pass a ICommBoundary through constructors, not ideal and requires non trivial refactoring and work.

I was thinking of making a basic interface like bind_comm_object() to set the global var, and for now get_comm_object() to get it. Later on I want to move to even more ergonomic interfaces for text logging and formatting.

If you want to try this issue, talk to me first. I'm not convinced this is a 100% good idea so I want to hear your opinion.

Contributor guide

Research direction
Evaluate the benefits of a global variable versus dependency injection for telemetry; discuss the trade offs with maintainers before implementation.
Tech stack
cpp
Domain
embedded iot
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
Mostly clear
Prerequisites
C++Dependency Injection
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40