[repo] Add comment style guideline to AGENTS.md#12077
Merged
Merged
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the AGENTS.md file to add a new guideline for comments, advising against redundant or trivial comments and emphasizing that comments should explain the reasoning behind complex logic or serve as public API documentation. There are no review comments, so there is no additional feedback to provide.
camsim99
approved these changes
Jul 1, 2026
camsim99
left a comment
camsim99
left a comment
Contributor
There was a problem hiding this comment.
I'm very pro this addition! Thanks!
reidbaker
added
the
autosubmit
pull Bot
pushed a commit
to Klomgor/flutter
that referenced
this pull request
Jul 2, 2026
…er#188916) flutter/packages@e742106...420e135 2026-07-02 [email protected] [material_ui] Migrate api sample code to @example dartdoc directive (flutter/packages#12078) 2026-07-02 [email protected] [material_ui] Move over more API samples (flutter/packages#12092) 2026-07-01 [email protected] [cupertino_ui] Migrate api sample code to @example dartdoc directive (flutter/packages#12063) 2026-07-01 [email protected] [cupertino_ui] Move over more API samples (flutter/packages#12086) 2026-07-01 [email protected] [two_dimensional_scrollables] Fix TreeView horizontal hit testing (flutter/packages#11859) 2026-07-01 [email protected] [camera_android_camerax][tool] Integrate dart_code_linter for cyclomatic complexity checks (flutter/packages#11999) 2026-07-01 [email protected] [cross_file] Add runnable example with main() (flutter/packages#11527) 2026-07-01 [email protected] [cupertino_ui] Enable `switch_test.dart` (flutter/packages#12076) 2026-07-01 [email protected] [cupertino_ui] Re-enable dialog_test.dart (flutter/packages#12057) 2026-07-01 [email protected] [cupertino_ui] Re-enable action_sheet_test.dart (flutter/packages#12055) 2026-07-01 [email protected] [cupertino_ui] Migrate `bottom_tab_bar_test.dart` to `SemanticsHandle` (flutter/packages#12012) 2026-07-01 [email protected] [repo] Add comment style guideline to AGENTS.md (flutter/packages#12077) 2026-07-01 [email protected] Adds pre-push readiness skill (flutter/packages#11935) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
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
2 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.
Adds a style guideline to
AGENTS.mdadvising agents and developers against adding redundant or trivial comments that simply restate code logic in English.This has been a pattern in my own observations and also was caught by stuart in #11943 after I missed it in my pre review. We currently have no evals so there is not a good way to test this change.
Pre-Review Checklist
[shared_preferences]///).This PR is exempt from version/CHANGELOG updates and tests because it only modifies repository-wide guide documentation.
Footnotes
Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩