-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Add an initial AGENTS.md #9716
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
Add an initial AGENTS.md #9716
Conversation
First attempt at an AGENTS.md file to make Jules more effective at creating PRs.
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 introduces an AGENTS.md
file, which is a guide for AI agents to contribute to the repository. This is a great initiative to improve automated contributions. The guide is comprehensive and covers environment setup, repository structure, tooling, and workflows. The changes also include updating repository tooling to recognize AGENTS.md
as a non-code-impacting file.
My review focuses on the correctness and clarity of the new guide. I've found a critical issue with the environment setup script that will prevent it from working, and a suggestion to improve clarity around git remote assumptions. Overall, with these fixes, this will be a valuable addition to the repository's documentation.
|
||
## Code Style | ||
|
||
All code must adhere to the repository's style guides. The `format` command handles most of this, but be aware of the specific style guides for each language, as detailed in [CONTRIBUTING.md](./CONTRIBUTING.md#style): |
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 added additional linting information in the flutter repo https://github.com/flutter/flutter/blob/2b07a4a1a041f5f3ea5e520de75144cffc9da0e1/.gemini/styleguide.md?plain=1#L31-L38
Might be worth adding that to CONTRIBUTING.md#style
.
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.
Hm, we actually don't do most of that linting here. I'll file an issue to follow up on adding more.
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.
LGTM
Although I'm not sure how to review the efficacy of docs for an agent, but I do think this could be considered great for a quick startup doc for new contributors.
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.
Seems like a good starting point for this. Easy to iterate on if it isn't working as intended of course.
Looks like tree-status isn't updating; everything is green. Landing manually. |
flutter/packages@f0645d8...1a72287 2025-08-01 stuartmorgan@google.com Add an initial AGENTS.md (flutter/packages#9716) 2025-08-01 engine-flutter-autoroll@skia.org Roll Flutter from c3279ca to 871849e (56 revisions) (flutter/packages#9728) 2025-08-01 gavrilko.alexander@gmail.com [webview_flutter_platform_interface] Provide flexible API for loading local HTML files (flutter/packages#9697) 2025-08-01 jessiewong401@gmail.com Extending Timeout on `Linux_android android_build_all_packages *` (flutter/packages#9717) 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 flutter-ecosystem@google.com 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
…r#173215) flutter/packages@f0645d8...1a72287 2025-08-01 stuartmorgan@google.com Add an initial AGENTS.md (flutter/packages#9716) 2025-08-01 engine-flutter-autoroll@skia.org Roll Flutter from c3279ca to 871849e (56 revisions) (flutter/packages#9728) 2025-08-01 gavrilko.alexander@gmail.com [webview_flutter_platform_interface] Provide flexible API for loading local HTML files (flutter/packages#9697) 2025-08-01 jessiewong401@gmail.com Extending Timeout on `Linux_android android_build_all_packages *` (flutter/packages#9717) 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 flutter-ecosystem@google.com 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
…r#173215) flutter/packages@f0645d8...1a72287 2025-08-01 stuartmorgan@google.com Add an initial AGENTS.md (flutter/packages#9716) 2025-08-01 engine-flutter-autoroll@skia.org Roll Flutter from c3279ca to 871849e (56 revisions) (flutter/packages#9728) 2025-08-01 gavrilko.alexander@gmail.com [webview_flutter_platform_interface] Provide flexible API for loading local HTML files (flutter/packages#9697) 2025-08-01 jessiewong401@gmail.com Extending Timeout on `Linux_android android_build_all_packages *` (flutter/packages#9717) 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 flutter-ecosystem@google.com 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
…r#173215) flutter/packages@f0645d8...1a72287 2025-08-01 stuartmorgan@google.com Add an initial AGENTS.md (flutter/packages#9716) 2025-08-01 engine-flutter-autoroll@skia.org Roll Flutter from c3279ca to 871849e (56 revisions) (flutter/packages#9728) 2025-08-01 gavrilko.alexander@gmail.com [webview_flutter_platform_interface] Provide flexible API for loading local HTML files (flutter/packages#9697) 2025-08-01 jessiewong401@gmail.com Extending Timeout on `Linux_android android_build_all_packages *` (flutter/packages#9717) 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 flutter-ecosystem@google.com 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
First attempt at an AGENTS.md file to make Jules more effective at creating PRs.
I started with an initial draft, then iterated based on feedback from Gemini Code Assist, taking most of its suggestions (under the theory that it has more examples of AGENTS.md files in its model than I do), but removing some hallucinations.
I was going to put the "Agent Environment Setup" in a separate file, so that people could manually add it to their Jules configuration, but Gemini found that file and thought it should be in AGENTS.md. I'm curious to see if that will work well enough that we don't each need to do the manual one-time configuration. If it doesn't work, we can move it later.
🤷🏻