Instrucciones de origen · Vista previa de solo lectura
name
frb-prepare-pr
description
Use when about to create a PR or push changes in flutter_rust_bridge to ensure code generation is up to date
FRB Prepare for PR
Note: Check your user-level remote-testing rules before running commands. Codegen, lint, and tests may require remote execution.
Overview
Before creating a PR, ensure generated code is up to date, lint passes, and bug fixes have a concrete reproduction report in the PR description. Before treating a non-trivial PR as ready, run frb-pr-review.
Core principle: Generate → Lint → Commit → PR.
After codegen: Check your user-level remote-testing rules. If codegen was run remotely, pull changes back to local.
Workflow
1. Read frb-code-generation skill
|
+-- Run required generation commands
|
+-- 2. For integrate output diffs, verify templates and run precommit-integrate
|
+-- 3. Read frb-lint skill --> Run lint --fix
|
+-- 4. (Optional) Read frb-test skill --> Run relevant tests
|
+-- 5. For non-trivial PRs, read frb-pr-review --> Run review gate
|
+-- 6. For bug fixes, add the reproduction report to the PR description
|
+-- 7. Commit all changes
|
+-- 8. Create PR (use creating-pull-requests skill)
Quick Checklist
REQUIRED: Read frb-code-generation skill, run commands if needed
REQUIRED for integrate output diffs: If the PR changes Flutter integrate example outputs or platform scaffolds, confirm whether frb_codegen/assets/integration_template/ is the source that should change, then run ./frb_internal precommit-integrate
REQUIRED for copied Cargokit diffs: If the PR changes copied cargokit files under frb_example/**, read frb-cargokit, then run ./frb_internal sync-cargokit-copies
REQUIRED: Read frb-lint skill, run ./frb_internal lint --fix
(Optional) Read frb-test skill, run relevant tests
REQUIRED for non-trivial PRs: Read frb-pr-review, run the review gate before final readiness
REQUIRED for bug fixes: PR description includes the reproduction report from frb-develop-feature, including baseline commit, mechanical steps, observed failure, and expected behavior
REQUIRED for CI iteration branches: Read frb-ci-filter, then remove ci-manual-dispatch and rerun normal CI if the PR used filtered CI, unless the PR is explicitly about changing CI behavior
Commit all changes
Push and create PR
What CI Will Do
CI automatically runs:
Code generation check (fails if generated code is outdated)
All tests (Rust, Dart, Flutter, Web)
Lint and format checks
Run lint locally to avoid CI failures. Tests are optional locally.
While iterating, it can be useful to dispatch .github/workflows/ci.yaml with ci_filter so only the relevant job family or matrix entry runs. Read frb-ci-filter before doing this. Do not leave ci-manual-dispatch on the final PR unless changing CI behavior is the actual purpose of the PR.
If your PR fixes Flutter integrate example outputs and the real bug is inside the embedded cargokit submodule, do not stop at copied example files. Push the cargokit fix to fzyzcjy/cargokit and update the submodule ref in this repo before pushing the PR branch.
If the PR changes integrate-generated example output but not frb_codegen/assets/integration_template/, explicitly verify that the output-only change is intentional. Most integrate scaffold behavior should be fixed in the template and regenerated, not patched only in frb_example/**.
Related Skills
frb-code-generation - Determines which generation commands to run
frb-lint - Lint and format checks
frb-test - For local debugging when CI fails
frb-pr-review - PR readiness review gate
frb-ci-filter - Filtered CI dispatch rules
creating-pull-requests - Standard PR creation process
