Added md comment for formatting

UBCSailbot · Nov 18, 2023 · fafa3a8 · fafa3a8
1 parent 08275a3
commit fafa3a8
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -14,7 +14,11 @@ documented in the `.msg` or `.srv` file associated with that interface.
 ROS messages and services used across many ROS packages in the project.
 
 ### Project-wide External Interfaces
-
+<!---
+Formatting reminder:
+1. Keep 'Type' column organized alphabetically
+2. 'mock' version of topic should be after its common counterpart
+--->
 | Topic                  | Type           | Publisher                | Subscriber(s)                               |
 | ---------------------- | -------------- | ------------------------ | ------------------------------------------- |
 | `ais_ships`            | AISShips       | CANTransceiverROSIntf    | Local Pathfinding, Local Transceiver        |