rails-code-conventions

What problem does it solve?

An actionable guide to maintainable Rails code by applying core design principles (DRY, YAGNI, PORO, CoC, KISS), per-path rules, structured logging, and disciplined commenting to ensure consistent, high-quality code across models, services, controllers, workers, and repositories.

Core Features & Use Cases

• Defines a consistent design blueprint for Rails projects, including principles, per-area rules, and logging guidance.
• Helps teams enforce coding standards during reviews and onboarding, reducing technical debt and improving maintainability.
• Use Case: When starting a new Rails feature, consult the conventions to structure services, models, and jobs with clear responsibilities and logging practices.

Quick Start

Apply these conventions when starting a Rails codebase audit to ensure DRY, PORO, and clean logging across models, services, controllers, and jobs.