Add code comment rules to Rails' AI rules - #805
Open
jaredlt wants to merge 1 commit into
Open
Conversation
I find most of the AI models to be quite comment-happy. I'm constantly telling them to not use comments and often reteaching it that a comment is often a smell indicating eg. a missing method that could tell the story better in the code. This change introduces code comment rules for AI agents. Leading them away from comments but at the same time explaining how they can better tell the story in code, tests and commit messages. After a bunch of testing across a number of my projects to good results, it felt like time to suggest adding this into our guides.
MatheusRich
approved these changes
Aug 14, 2026
|
This is my first time seeing ai-rules ... do we have a space for this outside of rails? Because it seems like this is bigger than one framework. |
Contributor
Author
|
@iftheshoefritz I don't believe we have AI rules outside of Rails yet. All the other rules have been specific to Rails, so this is the first exception. I think I would rather get this in to improve the existing guides first (these rules are imported by every |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
I find most of the AI models to be quite comment-happy. I'm constantly telling them to not use comments and often re-teaching them that a comment is often a smell indicating eg. a missing method that could tell the story better in the code.
This change introduces code comment rules for AI agents. Leading them away from comments but at the same time explaining how they can better tell the story in code, tests and commit messages.
After a bunch of testing across a number of my projects to good results, it felt like time to suggest adding this into our guides.