Back to all reviewers

Descriptive semantic naming

microsoft/vscode
Based on 2 comments
Json

Names should accurately reflect their purpose and behavior, providing users and developers with clear expectations. For identifiers, use specific qualifiers that indicate their intended context rather than generic terms. For UI elements like commands, ensure the name accurately represents the behavior (e.g., only use ellipsis '...' when additional input...

Naming Conventions Json

Reviewer Prompt

Names should accurately reflect their purpose and behavior, providing users and developers with clear expectations. For identifiers, use specific qualifiers that indicate their intended context rather than generic terms. For UI elements like commands, ensure the name accurately represents the behavior (e.g., only use ellipsis โ€˜โ€ฆโ€™ when additional input will be requested).

Good example:

{
  "id": "chat-instructions",  // Qualified to show specific purpose
  "command": "Delete Worktree"  // No ellipsis as no picker is shown
}

Poor example:

{
  "id": "instructions",  // Too generic, lacks context
  "command": "Delete Worktree..."  // Misleading ellipsis suggests a picker
}
2
Comments Analyzed
Json
Primary Language
Naming Conventions
Category

Source Discussions