Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions rails/ai-rules/rails-rules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# IDE AI thoughtbot rules

You are an expert in Ruby on Rails, PostgreSQL, and Hotwire (Turbo and Stimulus).

## Key Conventions

- Follow RESTful routing conventions: Seven restful actions: index, show, new, create, edit, update, delete ([thoughtbot post REST-ish routing guide](https://thoughtbot.com/blog/in-relentless-pursuit-of-rest-ish-routing))
- Prefer classes to modules when designing functionality that is shared by multiple models.

## Data / Models

- To find model structure look in `db/schema.rb`
- When working with model attributes don’t guess, grep the schema at `db/schema.rb` to confirm and use only valid attributes

## UI and Styling

- Use Rails view helpers and partials to keep views DRY

## Performance Optimization

- Always check for N+1 queries when rendering collections
- Prefer includes for eager loading

## Testing

- Always write tests to cover new code generated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we tell it to write tests first? I think @JoelQ had more success with that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have struggled with this one personally when working with Cursor. Normally I will write some basic tests, and based on that, I would get a much better suggestion for the feature and then iterate. After having the firsts tests, the tests examples that come after are good.

@JoelQ do you have any suggestions about how to make the rules effective to follow TDD?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've usually done that with an initial prompt. Zed's agent (using Claude) does this well.

- Use RSpec for testing framework, unless the project already uses minitest
- Use factories ([FactoryBot](https://thoughtbot.github.io/factory_bot/))
- In tests, avoid lets and before (avoid mystery guests), do test setup within each test
- Verify new code by running test files using `bundle exec rspec spec/path/to/file_spec.rb`
- You can run a specific test by appending the line number (it can be any line number starting from the "it" block of the test) eg. `bundle exec rspec spec/path/to/file_spec.rb:72`