-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Add AI rules limits and compressed files #12969
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
Conversation
Summary of ChangesHello @johnpryan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly improves the documentation for AI rules files by introducing multiple compressed versions of the Flutter and Dart rules template, designed to accommodate the diverse context limits of various AI tools. It also provides a more comprehensive and updated table detailing specific AI coding assistants, their respective rules file configurations, and associated limits, making it easier for developers to integrate Flutter's AI guidelines effectively. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request updates the documentation for AI rules by adding information about different compressed versions of the rules files and expanding the table of supported tools with their specific character limits. The changes are clear and improve the usefulness of the document.
My review focuses on ensuring the changes adhere to the project's style guidelines, specifically the use of semantic line breaks with an 80-character limit, which was mentioned in the pull request description. I've left a few comments with suggestions on how to wrap long lines and use reference-style links to meet this requirement.
|
Visit the preview URL for this PR (updated for commit fcee312): https://flutter-docs-prod--pr12969-update-rules-limits-uscbsysq.web.app |
sfshaza2
left a comment
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.
A couple minor edits but, otherwise, lgtm
|
Waiting for @jwren to bless. |
|
I like the first list, but am unsure if we want to include the table. It seems like there will always be a missing tool and lots of changes. |
…bsite into update-rules-limits
_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
of 80 characters or fewer.