aadebuger-ComfyUI-EnglishAnnotator/CONTRIBUTING.md

Contributing

Issues and PRs are welcome.

PR guidelines

1. Test against the latest kijai/ComfyUI-Florence2. If their output schema changes, add a new branch to _coerce_bbox_list / _coerce_label_list in nodes/annotator.py — additive only, don't break existing shapes.
2. Keep the node API stable. New options go into the optional section of INPUT_TYPES, never into required, so existing workflows keep loading.
3. Add a CHANGELOG entry under an [Unreleased] heading.
4. Run a smoke test before submitting:

   curl -s http://localhost:8188/object_info | python3 -c \
     "import json,sys; print('EnglishWordAnnotator' in json.load(sys.stdin))"
   

Local dev loop

# Edit nodes/annotator.py, then restart ComfyUI to pick up changes.
pkill -9 -f main.py; sleep 3
cd /path/to/ComfyUI && source .venv/bin/activate
export HF_HOME=/path/to/hf_cache
nohup python main.py --listen 0.0.0.0 --port 8188 > ~/comfy_start.log 2>&1 &