Back to all reviewers

Consistent identifier naming

n8n-io/n8n
Based on 4 comments
Other

Follow consistent naming conventions for all identifiers to improve code quality, accessibility, and test reliability. Ensure correct spelling and adhere to established project patterns.

Naming Conventions Other

Reviewer Prompt

Follow consistent naming conventions for all identifiers to improve code quality, accessibility, and test reliability. Ensure correct spelling and adhere to established project patterns.

Key practices:

  1. Use precise spelling in HTML attributes and test IDs
    // โŒ Incorrect
    <label for="avalableInMCP">
    data-test-id="workflow-settings-vailable-in-mcp"
       
    // โœ… Correct
    <label for="availableInMCP">
    data-test-id="workflow-settings-available-in-mcp"
    
  2. Establish and follow consistent casing conventions:
    • For Vue events: decide between camelCase (thumbsUp) or kebab-case (thumbs-up) and use consistently
    • For component props: follow project conventions for complex types
  3. Use IDE tools and linters to enforce naming standards
    • Consider disabling overly restrictive rules team-wide rather than repeatedly suppressing them
    • Document naming conventions in your style guide for team alignment

This approach helps prevent broken references between HTML elements, ensures tests target the correct elements, and makes code more maintainable by following predictable patterns.

4
Comments Analyzed
Other
Primary Language
Naming Conventions
Category

Source Discussions