Establish and maintain consistent naming conventions across similar components and contexts. Inconsistent naming patterns make code harder to understand, discover, and maintain.
Key areas to focus on:
steps.X.eventCount
not step.digest.eventCount
)org_${orgId}:user_${userId}
)Example of inconsistent naming:
// Inconsistent - mixing singular and plural
const digestVar = 'step.digest.countSummary'; // singular 'step'
const otherVar = 'steps.workflow.events'; // plural 'steps'
// Consistent approach
const digestVar = 'steps.digest.countSummary'; // plural 'steps'
const otherVar = 'steps.workflow.events'; // plural 'steps'
Before introducing new naming patterns, verify they don’t conflict with existing validation rules or system constraints, and ensure they follow the established conventions in similar contexts.
Enter the URL of a public GitHub repository