Naming Convetions
Repository Structure#
| Scope | Naming Convention | Example |
|---|---|---|
| Group / organizational directories | lowercase, no prefix | infra/, common/, third_party/ |
ROS Packages#
| Scope | Naming Convention | Example |
|---|---|---|
| Micipsa-specific ROS packages | micipsa_<name> |
micipsa_hardware |
| Reusable generic packages | <name> (no prefix) |
manual_teleop |
Launch Files#
| Scope | Naming Convention | Example |
|---|---|---|
| Standard launch files | <scope>_launch.py |
localization_launch.py |
| Bringup launch files | <scope>.launch.py |
bringup.launch.py |
Configuration Files#
| Scope | Naming Convention | Example |
|---|---|---|
| YAML config files | <scope>.yaml |
ekf.yaml, nav2_params.yaml |
Containerization#
| Scope | Naming Convention | Example |
|---|---|---|
| Docker service names | lowercase, no prefix | actuation, localization |
Linux System Integration#
| Scope | Naming Convention | Example |
|---|---|---|
| Udev rules | 99-micipsa-<subsystem>.rules |
99-micipsa-serial.rules |
| Systemd units | micipsa-<subsystem>.service |
micipsa-hardware.service |
Testing#
| Scope | Naming Convention | Example |
|---|---|---|
| C++ unit tests | test_<unit>.cpp |
test_motor_driver.cpp |
| Python unit tests | test_<unit>.py |
test_teleop_node.py |
Integration tests (launch_testing) |
test_<scope>_integration_launch.py |
test_localization_integration_launch.py |