-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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.
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
laicuRoot
wants to merge
4
commits into
main
Choose a base branch
from
ai-rails-rules
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
- 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` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.