Maintain consistent naming patterns across related components and services. When implementing equivalent functionality in different services, use identical field/method names. When naming related fields that form logical groupings, either:
Maintain consistent naming patterns across related components and services. When implementing equivalent functionality in different services, use identical field/method names. When naming related fields that form logical groupings, either:
For request/response objects:
UpdateTaskQueueConfig
should match the equivalent in workflowservice)heartbeat_request
instead of request
)Example:
// GOOD: Consistent suffix pattern for related fields
int64 ack_level_pass = 4;
int64 ack_level_id = 2;
// BETTER: Using a structured type
message Level {
int64 pass = 1;
int64 id = 2;
}
Level ack_level = 2;
// BAD: Inconsistent naming pattern
int64 ack_level_pass = 4;
int64 ack_level = 2; // Should be ack_level_id
Consistent naming reduces cognitive load, improves readability, and helps prevent errors when working across service boundaries.
Enter the URL of a public GitHub repository