Active-Flight-Control

Overview

Hardware

Code

Guidelines

1. Use constexpr wherever possible instead of macros - minimal
2. No manual heap allocations - prevent potential memory leak bugs
3. Class Names and Structs start with Uppercase characters
4. camelCase, not name_name
5. filenames use _
6. use couts, not printf (type safety)
7. Comments should explain why the code exists
8. Document functions if they are complex enough
9. Functions <= 80 lines

Repository Structure

1. lib/
   • contains custom libraries or libraries that could not be resolved by platformio lib_deps
2. src/
   • contains source code for the logic of each component
3. include/
   • header files that declare functions and desired globals for each source file
   • each source file has its own header file to declare components and global variables
4. deprecated/
   • previous files/systems that were made but have been relplaced by different files/systems due to updated architecture or whatever other reason
5. tests/
   • units tests or general files
6. logs/
   • houses logs generated by the flight controller for analysis

Version Control

1. main
   • Deployable functioning code that will work
2. development
   • all new code/changes are pushed in this branch first to ensure functionality
   • must pr with main once testing is functional to keep updated
3. other
   • sub-branches of development branch where features are implemented