SoftwareEng_Fall2024

MVP has the rubric items and details on running the project.

MVP Readme

Team Members

John Leidy
Technical Manager
Software Architect
Director of Software Engineering

Dorian Bell II
Project Manager
Quality Assurace Specialist

Jorge Puga Hernandez
Quality Assurance Specialist
Software Engineer

Ben Kanter
AI & Machine Learning Specialist
Software Engineer

Tim Carpenter
AI & Machine Learning Specialist
Software Engineer

Anthony Bates
UX Engineer & Specialist
Software Engineer

Branch Hierarchy

Master

• Master contains everything approved for 'deployment'
  • For development needs, see dev
• This branch is highly protected and should be infrequently updated
• Approval for deployment requires an ok by at least 4/6 engineers on the team
  • The Project Manager, Technical Manager, and at least 2 other engineers

Dev

• Our primary/default branch is dev
  • All part / feature branches are based on dev -- the development branch
• The dev branch will largely take on the role that master traditionally does, while the real master largely lies untouched
• Updates to dev should be handled with care.
  • The technical manager should review all PRs directed into this branch

About MVP

MVP is the subdirectory that houses all of the moving parts of this tool.
See the MVP/README.md within MVP for information.

Documentation

• Our documentation standard requires that we utilize TypeDoc conventions to annotate all functions, classes, interfaces, etc. within .ts files.
• Outside of .ts files, documentation consists of README files in applicable subdirectories.