Software Standards
This document is intended to codify a set of standards and practices for developing high-quality and interoperable software and firmware across the QUT Robotics ROAR team. Before writing any software, you should have fully read through both the General and language-specific (C++, Python, JS/TS) sections. Additionally, if you're writing ROS or Svelte code, you should also have read through the relevant sections of the framework standards section. If you don't fully understand some of the topics being referenced, feel free to ask questions in Discord, we'll be happy to help, and if enough people have the same questions, we'll edit this document to add explanations.
:glob:
:hidden:
software/cpp
software/python
software/typescript
software/frameworks
software/general
Further Reading
- c++ standards are heavily based off the OpenStack C++ standards.
- JS/TS standards are heavily based off MDN Developer Guidelines.