Add table detailing AI rule file character limits for various tools#179817
Conversation
There was a problem hiding this comment.
Code Review
This pull request adds a helpful markdown table to docs/rules/README.md detailing the character limits for AI rule files across various tools. The table is well-structured and informative. My main suggestion is to enhance the 'Notes �&� Sources' column by adding hyperlinks to the source documentation, which would make the information more easily verifiable for readers.
| | Tool / Product | Rules File / Feature | **Soft / Hard Limit** | Notes & Sources | | ||
| | :--- | :--- | :--- | :--- | | ||
| | **Aider** | `.aider.conf.yml` / `CONVENTIONS.md` | **No Hard Limit** | Uses `CONVENTIONS.md` for rules. Limited by model context window.<br>**Source:** Aider Docs: Configuration | | ||
| | **Antigravity** (Google) | `.agent/rules/*.md` | **12,000 characters** (Hard) | **Source:** User Screenshot (Client-side validation error).<br>No public documentation found specifying this exact client limit yet. | | ||
| | **CodeRabbit** | `.coderabbit.yaml` Instructions | **10,000 characters** (Hard) | "Instructions: max 10000 characters."<br>**Source:** CodeRabbit Docs: Configuration | | ||
| | **Cursor** | `.cursorrules` | **No Hard Limit** | "There is no limit to the .cursorrules file... generally recommend keeping valid rules."<br>**Source:** Cursor Community Forum | | ||
| | **Gemini CLI** | Input Context | **1M+ Tokens** (Context) | Limited by model context (approx 700k words). Practical per-file limits (e.g. 20MB) may apply.<br>**Source:** Google Cloud: Gemini Models | | ||
| | **GitHub Copilot** | **Chat** Instructions | **~2 Pages** (Soft) | "We recommend... no longer than 2 pages."<br>**Source:** GitHub Docs: Custom Instructions | | ||
| | **GitHub Copilot** | **Code Review** Instructions | **4,000 characters** (Hard) | "Instructions... limited to 4000 characters."<br>**Source:** GitHub Docs: Custom Instructions | | ||
| | **Goose** | `.goosehints` / `AGENTS.md` | **No Hard Limit** | Limited by model context. Auto-compacts conversation when full.<br>**Source:** Block Goose: Context Management | | ||
| | **JetBrains AI** | `.aiassistant/rules` | **No Hard Limit** | Limited only by the model's context window (prompts are trimmed if too large).<br>**Source:** JetBrains Blog: AI Assistant Update | | ||
| | **OpenAI** (ChatGPT) | Custom Instructions | **1,500 characters** (Hard) | "Instructions... 1500 character limit."<br>**Source:** OpenAI Help: Custom Instructions | |
There was a problem hiding this comment.
This is a very useful table. To make it even more helpful, consider adding hyperlinks to the sources in the 'Notes �&� Sources' column. This would allow readers to easily verify the information and get more context if needed.
For example, for Aider, you could change:
**Source:** Aider Docs: Configuration
to something like:
**Source:** [Aider Docs: Configuration](https://aider.chat/docs/configuration.html)
Applying this to all sources where a public URL is available would be a great improvement.
There was a problem hiding this comment.
agreed - not only would it help to know where these numbers come from but also it would give us a place to go when we inevitably need to update this
1a133cb to
56f41f5
Compare
6a1b1eb to
a4ca93a
Compare
a4ca93a to
4e358ad
Compare
|
URLs updated. |
jakemac53
left a comment
There was a problem hiding this comment.
LGTM with the caveat that I don't really have any flutter expertise
…lutter#179817) Co-authored-by: John Ryan <ryjohn@google.com>
_Description of what this PR is changing or adding, and why:_ This adds the new compressed rules files to our docs page. (flutter/flutter#179817) _Issues fixed by this PR (if any):_ _PRs or commits this PR depends on (if any):_ ## Presubmit checklist - [x] If you are unwilling, or unable, to sign the CLA, even for a _tiny_, one-word PR, please file an issue instead of a PR. - [x] If this PR is not meant to land until a future stable release, mark it as draft with an explanation. - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style)—for example, it doesn't use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first-person pronouns). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. --------- Co-authored-by: Shams Zakhour <44418985+sfshaza2@users.noreply.github.com>
_Description of what this PR is changing or adding, and why:_ This adds the new compressed rules files to our docs page. (flutter/flutter#179817) _Issues fixed by this PR (if any):_ _PRs or commits this PR depends on (if any):_ ## Presubmit checklist - [x] If you are unwilling, or unable, to sign the CLA, even for a _tiny_, one-word PR, please file an issue instead of a PR. - [x] If this PR is not meant to land until a future stable release, mark it as draft with an explanation. - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style)—for example, it doesn't use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first-person pronouns). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. --------- Co-authored-by: Shams Zakhour <44418985+sfshaza2@users.noreply.github.com>
…lutter#179817) Co-authored-by: John Ryan <ryjohn@google.com>

No description provided.