Ensure naming consistency across related components and throughout the codebase to prevent developer confusion and maintenance issues. When similar concepts use different naming variations, choose one pattern and apply it consistently.
Ensure naming consistency across related components and throughout the codebase to prevent developer confusion and maintenance issues. When similar concepts use different naming variations, choose one pattern and apply it consistently.
Key principles:
Example from the codebase:
# Inconsistent - causes confusion
metadata:
name: mtls-serve # directory uses "serve"
spec:
containers:
- name: mtls-serve
image: localhost:5000/mtls-server:latest # image uses "server"
# Consistent - clear and predictable
metadata:
name: mtls-server
spec:
containers:
- name: mtls-server
image: localhost:5000/mtls-server:latest
When updating legacy naming, prioritize consistency with the broader system over maintaining alignment with individual objects. This reduces cognitive load and prevents the type of confusion that “is going to trip someone up one day.”
Enter the URL of a public GitHub repository