Omnibus Restoration

Author(s): Kavin,

Background and Motivation

Omnibus was finished in a hurry for competition last term. As a result, the code base needs to be cleaned up before IREC 2023. This is an important prerequisite for being able to improve the code base for the next competition cycle.

Project Description, Requirements and Scope

We simply need to fix the code base until it is at a production level of quality. This largely entails the following.

Cleaning up the code, so it is more extensible, understandable and … well clean
Write comprehensive unit tests. Note this might entail changing the code to make it more unit test friendly. We will also need to rework the old unit tests
Writing high quality documentation. This has already started and is apart of a wider team effort to document stuff more

The scope is described above. However, it is worth specifying that no code improvements will take place at this stage. That is explicitly outside the scope of this project.

Required Documentation

Omnibus Tutorial
System Architecture Guide
Component-level Walkthroughs
- One for each source and sink

Deliverables Timeline

Date	Deliverable
October 31st	The actual code base for omnibus should be production level quality.
November 31st	All documentation should be written
December 15th	Unit tests should be written

Cost Analysis

Team member’s time.

Integration Concerns and Stakeholders

This project is vital to operations.