- When naming Senders and Receivers, use a_tx and b_rx respectively - where a is the thing the Sender is sending, and b is the thing Receiver is receiving. e.g. agent_message_sender, http_response_receiver.
-
Document above the declaration of the variable/struct member what’s being sent from where to where. Suggested format:
<src> --<what's being sent>—> <dst>.Example:
/// HTTP client task —-IDs of closed connections—-> TcpStealHandlerIf known, the meaning of the objects being sent is documented, not just their type.
-
- Don’t use “local” in naming in agent code, since it could be unclear if it’s local to the agent, or to the user’s system. Instead, use “agent”, “cluster”, “pod”, “container”, “layer”, “user_application” to specify where this item is local to.
- When using
unwraporexpect, always explain why it’s ok to do so in a comment (except for in tests obviously).