Names should follow established team conventions while accurately reflecting their purpose and functionality. Inconsistent naming schemes and misleading identifiers create confusion and maintenance overhead.
Names should follow established team conventions while accurately reflecting their purpose and functionality. Inconsistent naming schemes and misleading identifiers create confusion and maintenance overhead.
When naming identifiers, ensure they:
Examples:
test poetry export
(violates naming scheme), use test/export
poetry-update
(misleading - doesn’t actually update), use poetry-sync
(accurately reflects synchronization behavior)This applies to all identifiers including variables, functions, classes, configuration keys, labels, and hook names. Consistent and accurate naming improves code readability and reduces cognitive load for team members.
Enter the URL of a public GitHub repository