Back to all reviewers

Consistent descriptive naming patterns

chef/chef
Based on 7 comments
Ruby

Use clear, descriptive names that follow consistent patterns across the codebase. For methods and properties: 1. Use intention-revealing names that clearly indicate purpose

Naming Conventions Ruby

Reviewer Prompt

Use clear, descriptive names that follow consistent patterns across the codebase. For methods and properties:

  1. Use intention-revealing names that clearly indicate purpose
  2. For boolean methods, use question-mark suffixes and appropriate prefixes
  3. Maintain consistent naming patterns across similar properties
  4. Use lowercase for variables unless they are true constants

Examples:

# Poor naming
def compare_users  # unclear if returns boolean
def detect_certificate_key  # verb is ambiguous
property :certpassword  # inconsistent with other properties

# Good naming
def users_changed?  # clear boolean return
def certificate_key_exist?  # clear boolean check
property :cert_password  # consistent with other properties

# Property naming consistency
property :user      # preferred over user_name
property :password  # preferred over pass

This pattern improves code readability, maintains consistency, and reduces cognitive load when working across different parts of the codebase.

7
Comments Analyzed
Ruby
Primary Language
Naming Conventions
Category

Source Discussions