Back to all reviewers

Capitalize acronyms consistently

langfuse/langfuse
Based on 2 comments
Json

Use standard capitalization for acronyms in all identifiers, method names, variables, and other code elements. Common acronyms like 'API', 'URL', 'JSON', 'HTML', and 'XML' should be written in all uppercase letters.

Naming Conventions Json

Reviewer Prompt

Use standard capitalization for acronyms in all identifiers, method names, variables, and other code elements. Common acronyms like ‘API’, ‘URL’, ‘JSON’, ‘HTML’, and ‘XML’ should be written in all uppercase letters.

This applies to all contexts:

  • Function names: getAPIKeys instead of getApiKeys
  • Variable names: userAPIConfig instead of userApiConfig
  • API endpoint names: "name": "Get API Keys" instead of "name": "Get Api Keys"
  • Text content in comments and documentation

For example, in our API endpoint definitions:

{
  "_type": "endpoint",
  "name": "Get API Keys",  // Correct - acronym fully capitalized
  ...
}

Instead of:

{
  "_type": "endpoint",
  "name": "Get Api Keys",  // Incorrect - inconsistent acronym capitalization
  ...
}

Consistent acronym capitalization improves code readability, maintains professional standards across the codebase, and helps ensure interface consistency for users.

2
Comments Analyzed
Json
Primary Language
Naming Conventions
Category

Source Discussions