Prompt
Maintain consistent naming conventions throughout the codebase to improve readability and maintainability. This applies to translation keys, command names, variables, and terminology.
For translation keys:
- Choose one style (camelCase, snake_case, or dot notation) and apply it consistently
- Avoid mixing styles like
dataStore.tab.labelwithdata.store.empty.labelorcontextMenu.FilterExecutionsBywith references tocontextMenu.filter_executions_by
For command and function names:
- Name should clearly reflect the actual purpose and behavior
- For example, use
test:e2eortest:playwrightinstead of the ambiguoustest:dockerif the command runs playwright tests - Use
test:show:reportinstead oftest:reportto clarify the action being performed
For terminology:
- Use consistent terms for the same concepts throughout the application
- Avoid replacing established terms (like changing ‘workflow’ to ‘automation sequence’) without updating all references
Consistency in naming reduces cognitive load for developers, prevents bugs from mismatched references, and makes the codebase more maintainable over time.