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

Refactor Library Structure

Open
#137 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

Our directory structure is currently a bit messy, with convoluted platform and general folders that will soon become unneeded anyway

Desired Additional Features

With the completion of #138 , all drivers should be stm platform agnostic anyway, and with the completion of #139 , they will become completely decoupled with hardware. So, our dir structure doesn't need to distinguish between these.

The simpliest re-implementation is simply

base
--> Drivers
--> Middleware

But im not opposed to more detailed breakdown if it made sense

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

Begin by reviewing the existing platform and general directories, then read issues #138 and #139 to confirm their driver and hardware assumptions. Done means agreeing on and applying a replacement structure, at minimum base/Drivers and base/Middleware, without platform or hardware distinctions.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
embedded-iot
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.