
Standard SKILL-convention Rails skill
概览
A practical Rails skill for teams that value consistency Build and review Rails 8 code by matching the codebase you already have, not by forcing generic patterns that don’t fit your app. rails-conventions is for real production work in Rails codebases where consistency matters. - inspect local patterns first (models, controllers, routes, tests, deploy setup) - keep naming and architecture aligned with existing conventions - write backend-aware job code (good_job or solid_queue) without assumptions - catch risks early in security, performance, and test coverage - write value-based tests split by responsibility (deep unit coverage, thin request checks) - generate migrations and installer files instead of inventing them - reuse existing Ruby, Rails, and installed library APIs before writing helpers - diagnose bugs through testable hypotheses and verify regressions before/after - turn repeated mistakes into safeguards and measure equivalent work - Ruby 4.0+/Rails 8.
README
以下为原文 README 节选,完整内容请查看原文。
rails-conventions
A practical Rails skill for teams that value consistency
Build and review Rails 8 code by matching the codebase you already have, not by forcing generic patterns that don’t fit your app.
SKILL.md · References
What this skill helps with
rails-conventions is for real production work in Rails codebases where consistency matters.
It guides agents to:
- inspect local patterns first (models, controllers, routes, tests, deploy setup)
- keep naming and architecture aligned with existing conventions
- write backend-aware job code (
good_joborsolid_queue) without assumptions - catch risks early in security, performance, and test coverage
- write value-based tests split by responsibility (deep unit coverage, thin request checks)
- generate migrations and installer files instead of inventing them
- reuse existing Ruby, Rails, and installed library APIs before writing helpers
- diagnose bugs through testable hypotheses and verify regressions before/after
- turn repeated mistakes into safeguards and measure equivalent work
Coverage
- Ruby 4.0+/Rails 8.1+ baseline, stable releases, and native API discovery
- Naming, layering, and code organization
- Active Record modeling, PostgreSQL features, and migration discipline
- Controllers, params, and response semantics
- REST/resource-focused routing
- Hotwire/Turbo/Stimulus patterns (including realtime posture)
- Background jobs (adapter detection + backend-specific guidance)
- Webhook inbound/outbound delivery reliability
- Performance and caching strategy
- Security checklist (including SSRF hardening and tenancy)
- Testing strategy (value-based assertions, Minitest and Minitest::Mock)
- API and serialization conventions
- Evidence-driven debugging, review, and realistic skill evaluation
- Mailer composition and previews
- Maintenance tasks, one-off cleanup, and maintained documentation
- Optional 37signals-inspired profile
- Generator-owned files policy (migrations, installers — never invent them)
Validate, install, and update
Run the bundled validation script before publishing changes:
ruby scripts/validate_skill.rb
Install or update the skill with skills:
# install from source
npx skills add [email protected]:ethos-link/rails-conventions.git --skill rails-conventions
# update an existing install
npx skills update rails-conventions
Forward-test prompts
Use these prompts to check that the skill triggers correctly and loads only the references needed for the task:
Implement a new billing webhook endpoint in this Rails app, matching existing conventions and tests.
Review this Rails 8 pull request for production readiness, focusing on naming, data integrity, security, and missing tests.
推荐工具
换一个关键词,或者移除筛选条件。
安装
npx skillfish add ethos-link/rails-conventions