Skip to content

feat: define thoughtbot rules for AI-enabled IDEs #764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: define thoughtbot rules for AI-enabled IDEs #764

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
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 (https://thoughtbot.com/blog/in-relentless-pursuit-of-rest-ish-routing)

Check failure on line 7 in rails/ai-rules/rails-rules.md

View workflow job for this annotation

GitHub Actions / lint

Bare URL used 

rails/ai-rules/rails-rules.md:7:110 MD034/no-bare-urls Bare URL used [Context: "https://thoughtbot.com/blog/in..."] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md034.md
- Use concerns for shared behavior across models or controllers

## 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

- Optimize database queries using includes, joins, or select

## Testing

- Always write tests to cover new code generated
- Prefer RSpec for Rails applications but use the existing test framework if there is one
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if this is too generic? My understanding is that AI instruction files benefit from being super specific to the project it's running. Have we been using this instruction successfully on a variety of projects?

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree these are generic but I think the intention is for them to be a starting point for getting up and running with instructions. These rules make sense across all our rails projects and then you can add to them in your own project with more specific details. Do you think that is useful?

Copy link

Choose a reason for hiding this comment

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

I've started saying explicitly Use RSpec for projects that use RSpec. Given that's a thoughtbot default maybe we say that here as well. And then folks can change it if the application uses something else eg. minitest?

- Use factories (FactoryBot) (https://thoughtbot.github.io/factory_bot/)

Check failure on line 27 in rails/ai-rules/rails-rules.md

View workflow job for this annotation

GitHub Actions / lint

Bare URL used 

rails/ai-rules/rails-rules.md:27:31 MD034/no-bare-urls Bare URL used [Context: "https://thoughtbot.github.io/f..."] https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md034.md
- 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`

Loading