Ensure that names accurately reflect their purpose and maintain consistency with established patterns in the codebase. Method names should clearly indicate their behavior - avoid misleading conventions when they don’t match the actual functionality. Similarly, maintain consistent naming patterns across similar contexts.
For example, avoid using “set” prefixes for methods that don’t actually set a value:
// Misleading - implies setting a value
setNotificationDismissed: (notificationId: string) => void
// Clear - accurately describes the action
markNotificationAsDismissed: (notificationId: string) => void
Also ensure consistency in organizational naming patterns:
// Inconsistent
title: "UI/Badge" // in Badge.stories.tsx
title: "Component/Button" // in Button.stories.tsx
// Consistent
title: "Component/Badge" // matches established pattern
title: "Component/Button"
This approach helps maintain code readability and reduces confusion for team members working across different parts of the codebase.
Enter the URL of a public GitHub repository