Workflow: Code Quality (40)

When to use: Apply conventions, refactor existing code, or maintain quality during development.

Main Flow: Refactoring

graph TB
    subgraph Prepare [🧪 Phase 1: Prepare]
        direction TB
        A[Refactor needed] --> B[refactor-safely]
        B --> C[Characterization tests]
        C --> D{Tests pass?}
    end

    subgraph Refactor [🔧 Phase 2: Refactor]
        direction TB
        D -- Yes --> E[Extract/refactor]
        E --> F{Tests pass?}
        F -- No --> G[Revert + fix]
        G --> E
    end

    subgraph Iterate [🔄 Phase 3: Iterate]
        direction TB
        F -- Yes --> H{More to refactor?}
        H -- Yes --> E
    end

    H -- No --> I[rails-code-review]

    %% Styling
    style Prepare fill:#f5f5f5,stroke:#333,stroke-dasharray: 5 5
    style Refactor fill:#e1f5fe,stroke:#01579b
    style Iterate fill:#fff3e0,stroke:#e65100
    style D fill:#ffd54f
    style F fill:#ffd54f
    style H fill:#ffd54f

refactor-safely

Goal: Change structure without changing behavior.

Steps

1. Characterization tests: Write tests that document current behavior
2. Verify tests pass: On current code
3. Extract/modify: One boundary at a time
4. Verify: Tests pass after each change

Key rule: Separate behavior changes from structural changes. Never both.

rails-code-conventions

Goal: Clean code following Rails principles.

Daily Checklist

Principles

• DRY — Don't Repeat Yourself
• YAGNI — You Ain't Gonna Need It
• PORO — Plain Old Ruby Objects for complex logic
• CoC — Convention over Configuration
• KISS — Keep It Simple, Stupid

yard-documentation

Goal: Document public API after implementation.

When to use

• New public class method
• New public class
• Change to existing method signature

Required Tags

# @param params [Hash] :user_id, :amount
# @return [Hash] { success: Boolean, response: Hash }
# @raise [ArgumentError] when user_id is nil

Language: All YARD in English unless user requests otherwise.

Skills in this Workflow