mflux pull request workflow

When to Use

You’re about to open a PR (or want a safe sequence to do it).

Instructions

If you run tests as part of PR hygiene, prefer fast tests first:
- just test-fast
Keep commits focused and messages consistent with repo history.
If the PR changes CLI defaults, public APIs, or model behavior, check for README/example drift before opening the PR.
Always ask for permission before pushing to the remote repository.
If gh isn’t available, fall back to the GitHub web UI (or stop and ask).

PR body and release note (required)

The release-note CI check fails the PR if the body has no complete release-note block.

Use the mflux-pr-docs skill to write the PR body. That skill writes the What section and the release-note block, runs the CI check, and gets the approval of the developer.

If the check fails on an open PR, use the mflux-pr-docs skill again. It edits the body of the open PR. The check runs again on an edit. You do not need a new commit.

Pre-merge checklist (model port PRs)

Use after the core port lands and you are polishing for merge. For the full integration surfaces tick list (LoRA key formats, save routing, tokenizer edge cases, etc. learned from past closed PRs), see mflux-model-porting → Integration surfaces checklist.

Correctness

just lint and just test-fast
just ci-extract after changing AVAILABLE_MODELS or scripts/ci_extract_models.py

Slow golden tests for the new model:

MFLUX_PRESERVE_TEST_OUTPUT=1 uv run pytest tests/image_generation/test_generate_image_<model>.py -m slow -v

Optional but high-signal: diffusers side-by-side + latent injection (mflux-debugging, mflux-manual-testing)

Cross-model diff audit

List files changed outside src/mflux/models/<model>/:

Category	Expected
`pyproject.toml`, `cli/defaults/defaults.py`, `ModelConfig`, `mflux-save` routing	Required wiring
`scripts/ci_extract_models.py` `OVERLAY` / `EXTRA_ENTRIES`	Required CI-manifest wiring for every new model key or standalone tool
`README.md` table + attribution	Required
Training `runner.py`, example JSON, `.gitignore` JSON exceptions	If training supported
Shared VAE/callback/training one-liners	Only if required; document blast radius in PR
Personal `.gitignore`, unrelated formatting	Remove

Verify quantized README disk claims with measurement:

du -sh ~/.cache/huggingface/hub/models--<org>--<Model>*
mflux-save --model <alias> --quantize 8 --path /tmp/model-q8 && du -sh /tmp/model-q8

Docs / examples

Model README matches a recent port (e.g. Flux2): hero image, turbo + base CLI, feature section, disk warning, Notes, Training.
Main README.md model table row (correct release date).
Showcase asset if other models have one (src/mflux/assets/; may need git add -f when *.jpg is gitignored).

PR description callouts

Shared code touched and why (shared VAE, callbacks, training runner, etc.).
Reference pipeline features intentionally not ported (optional preprocessors, extra encoders, components omitted from mflux weight downloads).
Known non-parity with diffusers (RNG, sigma schedule, optional modules) if golden tests lock mflux-native sampling.

mflux-pr