mflux-pr

Guides pull request creation in the mflux repository with lint, test, and diff audit checks.

2.4k|187|Updated Aug 10, 2024
One-click install
npx skills add https://github.com/mflux-community/mflux --skill mflux-pr-mflux-community
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: mflux-pr
Source: https://github.com/mflux-community/mflux/tree/main/.cursor/skills/mflux-pr
Command: npx skills add https://github.com/mflux-community/mflux --skill mflux-pr-mflux-community

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Opening a pull request in the mflux repository involves many repo-specific conventions—fast tests, CI manifest wiring, README updates, and cross-model diff audits—that are easy to forget, leading to failed CI or review churn. ## Core Features & Use Cases - PR Hygiene Workflow: Runs fast tests first (just test-fast), keeps commits focused, and requires permission before pushing to the remote. - Pre-Merge Checklist for Model Ports: Covers lint, CI extraction checks, slow golden tests, and a cross-model diff audit table for files changed outside the model directory. - Docs and PR Description Guidance: Verifies README model tables, quantized disk claims with du -sh measurements, and callouts for shared code changes or non-parity with diffusers. - Use Case: After porting a new image model to mflux, use this Skill to audit every changed file, run the correct test tiers, and draft a PR description that documents shared-code blast radius. ## Quick Start Use the mflux-pr skill to verify my changes and prepare a pull request for the new model port I just finished.

Frequently Asked Questions about mflux-pr

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I open a pull request in the mflux repository?▼

Run `just lint` and `just test-fast` first, keep commits focused with messages matching repo history, then ask for permission before pushing. If the gh CLI is unavailable, fall back to the GitHub web UI.

What tests should I run before merging an mflux model port?▼

Run `just lint` and `just test-fast`, plus `just ci-extract` if you changed AVAILABLE_MODELS. Also run the slow golden tests for the new model with MFLUX_PRESERVE_TEST_OUTPUT=1 and pytest -m slow -v.

What files should change outside the model directory in an mflux port PR?▼

Expected changes include pyproject.toml, CLI defaults, ModelConfig, mflux-save routing, ci_extract_models.py entries, and the README model table. Personal .gitignore entries or unrelated formatting should be removed.

How do I verify quantized model disk size claims in mflux docs?▼

Measure the Hugging Face cache with `du -sh ~/.cache/huggingface/hub/models--<org>--<Model>*`, then save the quantized model with `mflux-save --quantize 8` and measure the output directory with du -sh.

What should an mflux PR description call out for model ports?▼

Call out any shared code touched (VAE, callbacks, training runner) and why, reference pipeline features intentionally not ported, and known non-parity with diffusers such as RNG or sigma schedule differences.