Back to all reviewers

Use clear, descriptive names

argoproj/argo-cd
Based on 2 comments
Other

Choose names that accurately describe their purpose and avoid unnecessary verbosity. Field names should semantically match what they contain or validate, and component names should be concise without redundant prefixes that don't add clarity.

Naming Conventions Other

Reviewer Prompt

Choose names that accurately describe their purpose and avoid unnecessary verbosity. Field names should semantically match what they contain or validate, and component names should be concise without redundant prefixes that don’t add clarity.

For example, when a field contains a validation pattern, use “format” instead of “type”:

-- Instead of:
["type"] = "^[0-9]*$",

-- Use:
["format"] = "^[0-9]*$",

Similarly, avoid redundant prefixes in component names:

# Instead of:
workload='argocd-repo-server'

# Use:
workload='repo-server'

This makes code more intuitive to read and components easier to find and reference.

2
Comments Analyzed
Other
Primary Language
Naming Conventions
Category

Source Discussions