Northeastern-Electric-Racing / Northeastern-Electric-Racing/Embedded-Base

Add a diagnostic script & alias to our Venv

Open
#148 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Current Features

Nothing

Desired Additional Features

As our team size scales, having a tool that might easily diagnose some common errors that could be run with a single alias could be really cool.

I imagine this will be a python script that runs stuff like the following:

  • checks repo structure to ensure it follows something like (NER/embedded base, NER/Cerberus, etc etc)

  • checks submodules within any app dirs (shepherd, cerb, msb, etc) and ensures the submodule isnt empty, and prints the git hash of the submodule commit

  • prints commit checked out on any app dirs

  • checks which shell and platform user is on

Im sure there are a lot more useful diagnostics to add, but these are ones that come to mind that could be very simple causes of some seemingly less obvious issues that may arise.

Screenshots (as needed)

No response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository structure, Venv setup, and app directories named in the issue; no specific file or test is identified. Done should mean a diagnostic script and single alias cover the proposed repository, submodule, commit, shell, and platform checks with useful output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.