agentleFS
igmarinigmarin/rails-agent-skills/skills/apply-stack-conventions/SKILL.md

apply-stack-conventions

Skill26 starsChanged 4 months agoMITView on GitHub

Use when writing new Rails code for the PostgreSQL + Hotwire + Tailwind stack. Not for general architecture review. Trigger words: stack conventions, PostgreSQL, Hotwire, Tailwind, Turbo, Stimulus.

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    All new code must have its test written and validated before implementation.

    line 29
  2. Distinctive:

    Write the spec file — show the full file content, not only the path

    line 31
  3. Very specific:

    Run: bundle exec rspec spec/[path]_spec.rb — verify it FAILS (Observed RED output)

    line 32
  4. Distinctive:

    Write the implementation code

    line 33
  5. Distinctive:

    Style: If the project uses a linter, treat it as the source of truth for formatting.

    line 78
  6. Distinctive:

    Every response must include these sections in order:

    line 120

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Apply Stack Conventions

Quick Reference

Stack areaDefault convention
Rails MVCThin controllers; move non-trivial business logic into service objects
PostgreSQLAvoid N+1s with includes; use database constraints for integrity
HotwirePrefer Turbo Frames/Streams before Stimulus; only reach for Stimulus when Turbo cannot handle the interactivity
TailwindUse utilities in views; extract repeated UI into partials/components
AuthApply Devise authentication and Pundit authorization to every action that touches access-controlled resources

HARD-GATE: TDD Cycle

All new code must have its test written and validated before implementation. Follow this exact cycle for every layer:

  1. Write the spec file — show the full file content, not only the path
  2. Run: bundle exec rspec spec/[path]_spec.rb — verify it FAILS (Observed RED output)
  3. Write the implementation code
  4. Re-run the same command — verify it PASSES (Observed GREEN output)
  5. Refactor if needed, keeping tests green

CRITICAL: Execute all test commands using your shell/terminal tools. Do not fabricate, mock, or simulate terminal output. Copy-paste the actual observed output. If the environment does not support running tests, stop and tell the user — do not proceed to implementation without verified RED output.

Red-Green Cycle Example

Spec file — spec/models/order_spec.rb

require 'rails_helper'

RSpec.describe Order, type: :model do
  describe 'validations' do
    it 'is invalid without a total' do
      order = build(:order, total: nil)
      expect(order).not_to be_valid
      expect(order.errors[:total]).to include("can't be blank")
    end
  end
end

Run command

bundle exec rspec spec/models/order_spec.rb

Observed RED output — paste actual terminal output here (expect failure)

Model implementation — app/models/order.rb

class Order < ApplicationRecord
  validates :total, presence: true
end

Observed GREEN output — paste actual terminal output here (expect pass)

Core Process

Stack: Ruby on Rails, PostgreSQL, Hotwire (Turbo + Stimulus), Tailwind CSS.

Style: If the project uses a linter, treat it as the source of truth for formatting. For cross-cutting design principles (DRY, YAGNI, structured logging, rules by directory), use apply-code-conventions.

Feature Development Workflow

For a typical feature, compose stack patterns in this order:

  1. Model — add validations, associations, scopes; eager-load with includes for any association used in loops
  2. Service object — extract non-trivial business logic from the controller (see create-service-object)
  3. Controller — keep actions thin; delegate to services; respond with turbo_stream and html formats
  4. View / Turbo wiring — wrap dynamic sections in <turbo-frame> tags; broadcast turbo_stream responses from the controller
  5. Stimulus — add a controller only when client-side interactivity cannot be handled by Turbo alone
  6. Tailwind — apply utility classes to the view; extract repeated patterns into partials or Stimulus targets

Each step should remain testable in isolation before wiring to the next layer. In the final artifact, include a Layer isolation section naming the focused spec or check for model/query, service, controller/request, view/Turbo, Stimulus, and Tailwind. If a layer is not changed, mark it "not applicable"; do not silently omit any layer.

Service Object Pattern

Controllers delegate to a service via .call; the service returns a result hash. See create-service-object and assets/snippets/service_object.rb for the full pattern and implementation details.

# app/controllers/orders_controller.rb
def create
  result = CreateOrderService.call(order_params)
  if result[:success]
    redirect_to result[:record], notice: 'Order created.'
  else
    render :new, status: :unprocessable_entity
  end
end

For eager loading patterns and N+1 fixes, see the Extended Resources section below.

Pitfalls to Avoid

IssueCorrect approach
Controller action with 15+ lines of business logicExtract to a service object using the .call pattern
Accessing a protected resource without an authorisation checkApply a Pundit policy on every action that touches access-controlled data

Output Style

Every response must include these sections in order:

  1. Stack decisions — which Rails, PostgreSQL, Hotwire, Stimulus, Tailwind, auth, and service-object conventions apply.
  2. Tests-first proof before implementation — follow the HARD-GATE cycle per layer (spec file content → RED output → implementation → GREEN output).
  3. Layer isolation — focused spec/check for each changed layer; mark unchanged layers "not applicable".
  4. Layered implementation — separate model/query, service, controller, view, Stimulus, and Tailwind changes.
  5. Performance and security checks — N+1 prevention, authorization policy use, unsafe params/content handling.

Extended Resources (Progressive Disclosure)

Load these files only when their specific content is needed:

  • assets/snippets/eager_loading.rb — Use when applying eager loading patterns to fix N+1 queries
  • assets/snippets/n_plus_one_fix_example.rb — Use when you need a complete N+1 fix example with before/after
  • assets/snippets/service_object.rb — Use when extracting controller logic into a service object
  • assets/snippets/turbo_frame.html.erb — Use when implementing Turbo Frame patterns
  • assets/snippets/stimulus_controller.js — Use when adding Stimulus controllers
  • assets/snippets/tailwind_component.html.erb — Use when building Tailwind-styled view components

Integration

SkillWhen to chain
apply-code-conventionsFor design principles, structured logging, and path-specific rules
code-reviewWhen reviewing existing code against these conventions
create-service-objectWhen extracting business logic into service objects
write-testsFor testing conventions and full red/green/refactor TDD cycle
review-architectureFor structural review beyond conventions

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.