42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
# Contributing
|
|
|
|
Thanks for your interest! Small contributions are very welcome.
|
|
|
|
## Filing issues
|
|
|
|
Useful info to include:
|
|
|
|
- ComfyUI commit (`git -C ComfyUI rev-parse HEAD`)
|
|
- `torch.__version__`, `transformers.__version__`, GPU model
|
|
- The exact `MIMO_ASR_REPO` you're pointing at + its commit hash
|
|
- Full traceback (not just the final line)
|
|
|
|
## Pull requests
|
|
|
|
1. Fork + branch from `main`.
|
|
2. Keep PRs scoped — one feature or fix per PR.
|
|
3. Match the existing style (the loader / transcribe nodes show the
|
|
intended pattern: lazy heavy imports, clear runtime errors, a
|
|
`_MODEL_CACHE` for anything expensive).
|
|
4. If you add a new node, add it to **both** `__init__.py` mapping dicts
|
|
and update the README's node table.
|
|
5. Bump `CHANGELOG.md` under `[Unreleased]`.
|
|
|
|
## Local sanity check
|
|
|
|
```bash
|
|
# Lint
|
|
python -m py_compile nodes/*.py cli/*.py
|
|
|
|
# Optional: install into a ComfyUI checkout and reload
|
|
ln -s "$(pwd)" /path/to/ComfyUI/custom_nodes/ComfyUI-MiMoASR
|
|
```
|
|
|
|
## Scope
|
|
|
|
This pack is intentionally minimal — just the two nodes needed to use
|
|
MiMo-V2.5-ASR from ComfyUI. Anything that belongs upstream (model code,
|
|
sampler changes, etc.) should go to
|
|
[XiaomiMiMo/MiMo-V2.5-ASR](https://github.com/XiaomiMiMo/MiMo-V2.5-ASR)
|
|
instead.
|