DHH Rails 风格指南：遵循 Rails 原生哲学的最佳实践与代码规范

dhh-rails-style by everyinc/compound-engineering-plugin

463 周安装量

11,600 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/everyinc/compound-engineering-plugin --skill dhh-rails-style

方法论开发代码规范

🇨🇳中文介绍

<essential_principles>

核心理念

"最好的代码是你无需编写的代码。次好的代码是那些明显正确的代码。"

原生 Rails 已足够强大：

优先使用丰富的领域模型而非服务对象
优先使用 CRUD 控制器而非自定义动作
使用 Concerns 进行横向代码共享
使用记录（Records）表示状态而非布尔列
一切皆基于数据库（无需 Redis）
在引入 gem 之前先构建解决方案

他们刻意避免使用：

devise（使用约 150 行的自定义身份验证替代）
pundit/cancancan（在模型中进行简单的角色检查）
sidekiq（使用基于数据库的 Solid Queue）
redis（所有功能都使用数据库）
view_component（局部模板工作良好）
GraphQL（REST 配合 Turbo 已足够）
factory_bot（固件更简单）
rspec（Rails 自带 Minitest）
Tailwind（使用原生 CSS 配合 layers）

开发理念：

发布、验证、优化 - 将原型质量的代码部署到生产环境以学习
修复根本原因，而非症状
优先进行写入时操作而非读取时计算
优先使用数据库约束而非 ActiveRecord 验证

</essential_principles>

控制器 - REST 映射、concerns、Turbo 响应、API 模式
模型 - Concerns、状态记录、回调、作用域、POROs
视图与前端 - Turbo、Stimulus、CSS、局部模板
架构 - 路由、多租户、身份验证、作业、缓存
测试 - Minitest、固件、集成测试
Gems 与依赖 - 使用什么 vs 避免什么

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

相关 Skills

find-skills 技能搜索工具 - Vercel Labs 开源智能体技能包管理器

776,000 周安装

Vercel React 最佳实践指南 | 58条Next.js性能优化规则与代码重构

261,300 周安装

Vercel Web界面规范检查工具 - 自动检测代码是否符合Web设计指南

210,800 周安装

agent-browser 浏览器自动化工具 - Vercel Labs 命令行网页操作与测试

140,500 周安装

代码审查 - 根据 DHH 风格审查代码

通用指南 - 理念与约定

请指定一个数字或描述您的任务。

响应	参考阅读
1, controller	controllers.md
2, model	models.md
3, view, frontend, turbo, stimulus, css	frontend.md
4, architecture, routing, auth, job, cache	architecture.md
5, test, testing, minitest, fixture	testing.md
6, gem, dependency, library	gems.md
7, review	阅读所有参考资料，然后审查代码
8, general task	根据上下文阅读相关参考资料

阅读相关参考资料后，将模式应用到用户的代码中。

动词： card.close, card.gild, board.publish（而非 set_style 方法）

谓词： card.closed?, card.golden?（根据相关记录的存在性派生）

Concerns： 描述能力的形容词（Closeable, Publishable, Watchable）

控制器： 与资源匹配的名词（Cards::ClosuresController）

chronologically, reverse_chronologically, alphabetically, latest
preloaded（标准的预加载名称）
indexed_by, sorted_by（参数化）
active, unassigned（业务术语，而非 SQL 风格）

创建新的资源，而非自定义动作：

POST /cards/:id/close    → POST /cards/:id/closure
DELETE /cards/:id/close  → DELETE /cards/:id/closure
POST /cards/:id/archive  → POST /cards/:id/archival

# 方括号内带空格的符号数组
before_action :set_message, only: %i[ show edit update destroy ]

# 私有方法缩进
  private
    def set_message
      @message = Message.find(params[:id])
    end

# 条件判断使用无表达式的 case
case
when params[:before].present?
  messages.page_before(params[:before])
else
  messages.last_page
end

# 使用感叹号方法进行快速失败
@message = Message.create!(params)

# 简单条件使用三元运算符
@room.direct? ? @room.users : @message.mentionees

状态即记录：

Card.joins(:closure)         # 已关闭的卡片
Card.where.missing(:closure) # 未关闭的卡片

belongs_to :creator, default: -> { Current.user }

模型上的授权：

class User < ApplicationRecord
  def can_administer?(message)
    message.creator == self || admin?
  end
end

所有详细模式见 references/：

文件	主题
controllers.md	REST 映射、concerns、Turbo 响应、API 模式、HTTP 缓存
models.md	Concerns、状态记录、回调、作用域、POROs、授权、广播
frontend.md	Turbo Streams、Stimulus 控制器、CSS layers、OKLCH 颜色、局部模板
architecture.md	路由、身份验证、作业、Current 属性、缓存、数据库模式
testing.md	Minitest、固件、单元/集成/系统测试、测试模式
gems.md	他们使用什么 vs 避免什么、决策框架、Gemfile 示例

<success_criteria> 当代码符合以下情况时，即遵循 DHH 风格：

控制器映射到资源的 CRUD 动词
模型使用 concerns 实现横向行为
状态通过记录而非布尔值跟踪
没有不必要的服务对象或抽象
优先使用基于数据库的解决方案而非外部服务
测试使用 Minitest 配合固件
使用 Turbo/Stimulus 实现交互性（无重型 JS 框架）
使用具有现代特性的原生 CSS（layers、OKLCH、嵌套）
授权逻辑位于 User 模型中
作业是调用模型方法的浅层包装器

重要免责声明：

LLM 生成的指南 - 可能包含不准确之处
Fizzy 的代码示例遵循 O'Saasy 许可证
非 37signals 附属或认可

🇺🇸English

<essential_principles>

Core Philosophy

"The best code is the code you don't write. The second best is the code that's obviously correct."

Vanilla Rails is plenty:

Rich domain models over service objects
CRUD controllers over custom actions
Concerns for horizontal code sharing
Records as state instead of boolean columns
Database-backed everything (no Redis)
Build solutions before reaching for gems

What they deliberately avoid:

devise (custom ~150-line auth instead)
pundit/cancancan (simple role checks in models)
sidekiq (Solid Queue uses database)
redis (database for everything)
view_component (partials work fine)
GraphQL (REST with Turbo sufficient)
factory_bot (fixtures are simpler)
rspec (Minitest ships with Rails)
Tailwind (native CSS with layers)

Development Philosophy:

Ship, Validate, Refine - prototype-quality code to production to learn
Fix root causes, not symptoms
Write-time operations over read-time computations
Database constraints over ActiveRecord validations </essential_principles>

Controllers - REST mapping, concerns, Turbo responses, API patterns
Models - Concerns, state records, callbacks, scopes, POROs
Views & Frontend - Turbo, Stimulus, CSS, partials
Architecture - Routing, multi-tenancy, authentication, jobs, caching
Testing - Minitest, fixtures, integration tests
Gems & Dependencies - What to use vs avoid
Code Review - Review code against DHH style
General Guidance - Philosophy and conventions

Specify a number or describe your task.

Response	Reference to Read
1, controller	controllers.md
2, model	models.md
3, view, frontend, turbo, stimulus, css	frontend.md
4, architecture, routing, auth, job, cache	architecture.md
5, test, testing, minitest, fixture	testing.md
6, gem, dependency, library	gems.md
7, review

After reading relevant references, apply patterns to the user's code.

<quick_reference>

Naming Conventions

Verbs: card.close, card.gild, board.publish (not set_style methods)

Predicates: card.closed?, card.golden? (derived from presence of related record)

Concerns: Adjectives describing capability (Closeable, Publishable, Watchable)

Controllers: Nouns matching resources (Cards::ClosuresController)

Scopes:

chronologically, reverse_chronologically, alphabetically, latest
preloaded (standard eager loading name)
indexed_by, sorted_by (parameterized)
active, unassigned (business terms, not SQL-ish)

REST Mapping

Instead of custom actions, create new resources:

POST /cards/:id/close    → POST /cards/:id/closure
DELETE /cards/:id/close  → DELETE /cards/:id/closure
POST /cards/:id/archive  → POST /cards/:id/archival

Ruby Syntax Preferences

# Symbol arrays with spaces inside brackets
before_action :set_message, only: %i[ show edit update destroy ]

# Private method indentation
  private
    def set_message
      @message = Message.find(params[:id])
    end

# Expression-less case for conditionals
case
when params[:before].present?
  messages.page_before(params[:before])
else
  messages.last_page
end

# Bang methods for fail-fast
@message = Message.create!(params)

# Ternaries for simple conditionals
@room.direct? ? @room.users : @message.mentionees

Key Patterns

State as Records:

Card.joins(:closure)         # closed cards
Card.where.missing(:closure) # open cards

Current Attributes:

belongs_to :creator, default: -> { Current.user }

Authorization on Models:

class User < ApplicationRecord
  def can_administer?(message)
    message.creator == self || admin?
  end
end

</quick_reference>

<reference_index>

Domain Knowledge

All detailed patterns in references/:

File	Topics
controllers.md	REST mapping, concerns, Turbo responses, API patterns, HTTP caching
models.md	Concerns, state records, callbacks, scopes, POROs, authorization, broadcasting
frontend.md	Turbo Streams, Stimulus controllers, CSS layers, OKLCH colors, partials
architecture.md	Routing, authentication, jobs, Current attributes, caching, database patterns
testing.md	Minitest, fixtures, unit/integration/system tests, testing patterns
gems.md

<success_criteria> Code follows DHH style when:

Controllers map to CRUD verbs on resources
Models use concerns for horizontal behavior
State is tracked via records, not booleans
No unnecessary service objects or abstractions
Database-backed solutions preferred over external services
Tests use Minitest with fixtures
Turbo/Stimulus for interactivity (no heavy JS frameworks)
Native CSS with modern features (layers, OKLCH, nesting)
Authorization logic lives on User model
Jobs are shallow wrappers calling model methods </success_criteria>

Important Disclaimers:

LLM-generated guide - may contain inaccuracies
Code examples from Fizzy are licensed under the O'Saasy License
Not affiliated with or endorsed by 37signals

Weekly Installs

367

Repository

everyinc/compou…g-plugin

GitHub Stars

10.9K

First Seen

Jan 20, 2026

Security Audits

Gen Agent Trust HubPass SocketPass SnykPass

Installed on

opencode323

codex310

gemini-cli308

github-copilot296

cursor280

claude-code279

React 组合模式指南：Vercel 组件架构最佳实践，提升代码可维护性

106,200 周安装

DHH Rails 风格指南：遵循 Rails 原生哲学的最佳实践与代码规范

🇨🇳中文介绍

核心理念

相关 Skills

命名约定

REST 映射

Ruby 语法偏好

关键模式

领域知识