Back to all reviewers

descriptive naming patterns

tree-sitter/tree-sitter
Based on 2 comments
Json

Use descriptive names that clearly indicate the expected format, convention, or constraints. This applies to template variables, configuration keys, and validation patterns. Names should communicate not just what something is, but how it should be formatted or what rules it follows.

Naming Conventions Json

Reviewer Prompt

Use descriptive names that clearly indicate the expected format, convention, or constraints. This applies to template variables, configuration keys, and validation patterns. Names should communicate not just what something is, but how it should be formatted or what rules it follows.

For template variables, include format hints in the name:

{
  "description": "CAMEL_PARSER_NAME grammar for tree-sitter"
}

For validation patterns, ensure they accommodate all valid naming conventions:

{
  "pattern": "^(source|text)(\\.[\\w\\-]+)+$"
}

This approach reduces ambiguity and helps developers understand naming requirements without consulting additional documentation.

2
Comments Analyzed
Json
Primary Language
Naming Conventions
Category

Source Discussions