bbatsov/rails-style-guide

Features

• Coding Standards - Provides a comprehensive collection of coding standards and best practices to ensure a maintainable codebase.
• Architectural Patterns - Establishes the foundational architecture for organizing models, controllers, and views in a Rails application.
• Ruby Code Standardization - Defines consistent naming conventions and structural rules to ensure long-term maintainability of the codebase.
• ActiveRecord Patterns - Provides architectural guidance on implementing the ActiveRecord pattern for data access and validation.
• API Design Guides - Provides professional guidelines for designing predictable and maintainable RESTful resource structures.
• Coding Standards - Establishes consistent naming conventions and architectural patterns to improve long-term maintainability.
• Database Schema Migrations - Establishes standards for reversible database schema migrations to ensure consistent state across environments.
• Database Management Patterns - Provides technical standards for writing secure queries and reversible migrations to ensure data integrity.
• Domain Model Implementations - Provides patterns for implementing business rules within dedicated model classes to separate logic from formatting.
• Lean Controller Patterns - Guides the movement of business rules from controllers to the model layer to maintain slim action handlers.
• Logic and Presentation Separation - Prescribes architectural patterns for separating business logic and data retrieval from the presentation layer.
• Domain Data Presentation Layers - Provides guidelines for separating business logic, data persistence, and presentation layers using MVC patterns.
• Coding Standards - Establishes a consistent set of coding standards and naming conventions for maintainable Rails projects.
• Development Guides - Provides technical recommendations for managing migrations, routing, and testing workflows.
• RESTful API Designs - Provides best practices for designing RESTful API endpoints that express clear relationships between data resources.
• Resource-Based Routing - Defines a standardized approach to mapping RESTful resources to controller actions using member and collection routes.
• Data Validation - Recommends extracting custom validators into dedicated files to standardize input data verification before persistence.
• Database Record Querying - Provides best practices for retrieving data using batch processing and secure placeholders to optimize performance and security.
• Package Dependency Management - Offers guidance on managing external dependencies and locking library versions for environment consistency.
• Application Settings Management - Provides structural recommendations for organizing initialization code and global application settings.
• Environment-Specific Loading - Defines how to organize and load configuration settings based on development, test, or production environments.
• Project Structure Organization - Recommends a structured directory layout for organizing custom assets and third-party libraries.
• Integration Testing - Guides the implementation of integration tests and time-manipulation helpers to verify complex real-world user flows.
• Integration Testing Workflows - Provides a structured approach to implementing integration tests and time-manipulation helpers.
• Reusable Template Fragments - Recommends using layouts and partials to create reusable and modular user interface fragments.
• Interface Text Localization - Recommends using externalized locale files to handle interface text localization for multiple languages.
• Presentation Layer Encapsulation - Provides standards for developing view layers that prevent direct data model access from the UI.
• Internationalization & Localization - Guides the implementation of internationalization using structured locale files and dot-separated keys.
• Code Quality and Patterns - Community-driven style guide for Ruby on Rails.
• Programming Languages - Community-driven style guide for Rails development.
• Coding Style Guides - Community-driven standards for framework development.

Star history