Use hierarchical prefixes and clear descriptive names to indicate the domain, source, and purpose of code elements. This improves code organization, searchability, and helps maintain consistency across the codebase.
Use hierarchical prefixes and clear descriptive names to indicate the domain, source, and purpose of code elements. This improves code organization, searchability, and helps maintain consistency across the codebase.
For metrics:
compute_
)pg_
for PostgreSQL data)oldest_frozen_xid_age
)For API methods:
GetDbSize
instead of DbSize
)request_id
, request_class
)Example:
// Metrics:
compute_pg_oldest_frozen_xid_age // Not: frozen_xid_age or compute_min_mxid_age
// API Methods:
rpc GetDbSize (DbSizeRequest) returns (DbSizeResponse); // Not: DbSize
// Message fields:
message GetPageRequest {
uint64 request_id = 1; // Consistent prefixing for request metadata
RequestLsn read_lsn = 2; // Specific, descriptive name vs. "common"
}
This avoids ambiguity, improves code readability, and makes the codebase more maintainable.
Enter the URL of a public GitHub repository