Preparing PR
Developmentpreparing-prPreparing PR is an Agent Skill for development published in the flutter/devtools repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Prepare a pull request by running presubmit with fixes. Use when preparing to commit or send a PR.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/flutter/devtools/blob/HEAD/.agents/skills/preparing-pr/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/preparing-pr, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Preparing a Pull Request
Follow these steps to prepare a pull request for DevTools:
- Verify
dtconfiguration:- Ensure
dtis available on the path by runningdt --helpor verifying its alias. - If not available, refer to the CONTRIBUTING guide for instructions on how to set up the
dtexecutable on your path.
- Ensure
- Update Flutter SDK:
- Run
dt update-flutter-sdkto ensure the SDK is up to date.
- Run
- Run Presubmit with Fixes:
- Run
dt presubmit --fixto address automated fixes. - If any issues remain or if the command fails, fix the issues manually and run
dt presubmit --fixagain to verify the fix.
- Run
- Run Tests for Affected Code:
- Use
git statusorgit diff upstream/masterto find changed files. - Run tests that are associated with the changed code. For example, if you edited
packages/devtools_app/lib/src/screens/logging/logging_screen.dart, run the logging tests underpackages/devtools_app/test/screens/logging/.
- Use
Verification
If any step fails, stop and address the issue, and then verify the issue is fixed before proceeding.
[!IMPORTANT] Do NOT commit or push changes without getting explicit user approval first.