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

Ringbuffer Upgrades

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

Nobody has claimed this yet.

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

Description

Description

Users should be able to get the Nth to last element and get a range of data from the ringbuffer. Also this shit is undocumented and needs to be documented and given a better interface.

Acceptance Criteria

Whatever the hell I want. Also it has to work.

Proposed Solution

Use good software practices and make it easy to use and intuitive. There's probably a great ringbuffer implementation on the internet to use.

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

No implementation files, tests, or entry points are named. Start by locating the ringbuffer implementation and determine how existing access works; define the Nth-to-last and range operations, improve the interface, and document the resulting behavior. Done requires agreed acceptance criteria and working, documented functionality.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.