EricRollei-Comfy_HunyuanImage3/Docs/CHECKLIST.md

🚀 GitHub Publishing Checklist

✅ Files Ready for GitHub

All necessary files have been created in: a:\Comfy25\ComfyUI_windows_portable\ComfyUI\custom_nodes\Eric_Hunyuan3\

Core Files:

• README.md - Comprehensive documentation
• LICENSE - MIT License
• CONTRIBUTING.md - Contribution guidelines
• requirements.txt - Python dependencies
• .gitignore - Excludes cache, models, etc.
• __init__.py - Node registration (existing)
• hunyuan_shared.py - Shared utilities (existing)
• hunyuan_full_bf16_nodes.py - BF16 loaders (existing)
• hunyuan_quantized_nodes.py - NF4 loaders + generation (existing)

Quantization Folder:

• quantization/README.md - Quantization docs
• quantization/hunyuan_quantize_nf4.py - Quantization script

Documentation:

• GITHUB_SETUP.md - Complete setup guide
• CHECKLIST.md - This file!

📋 Pre-Publishing Tasks

1. Update README Links

✅ Already Updated! All references to GitHub username have been changed to ericRollei.

Verified locations:

• Clone URL
• Issues link
• Discussions link
• Author credits

2. Test Installation

# In a fresh ComfyUI install or clean environment:
cd ComfyUI/custom_nodes
git clone https://github.com/YOUR_USERNAME/Eric_Hunyuan3.git
cd Eric_Hunyuan3
pip install -r requirements.txt
# Start ComfyUI and verify nodes appear

3. Verify .gitignore

# Make sure these are excluded:
- __pycache__/
- *.pyc
- *.safetensors (model files)
- .vscode/
- .env

4. Optional: Add Examples

Create examples/ folder with:

• Example workflow JSON files
• Sample output images
• Screenshots of nodes

🔧 Git Setup Commands

cd a:\Comfy25\ComfyUI_windows_portable\ComfyUI\custom_nodes\Eric_Hunyuan3

# 1. Initialize repository
git init

# 2. Add all files
git add .

# 3. Check what will be committed (verify no model files!)
git status

# 4. Create initial commit
git commit -m "Initial release: HunyuanImage-3.0 ComfyUI nodes v1.0.0

Features:
- Multiple loader nodes (BF16, NF4, Multi-GPU, optimized variants)
- Advanced generation with prompt rewriting via DeepSeek API
- Organized resolution controls with MP indicators
- Large image generation with CPU offload support
- Comprehensive VRAM management and error handling
- NF4 quantization tools included"

# 5. Create GitHub repo (on website first), then:
git remote add origin https://github.com/YOUR_USERNAME/Eric_Hunyuan3.git

# 6. Push to GitHub
git branch -M main
git push -u origin main

📦 Create Release on GitHub

1. Go to your repo on GitHub
2. Click "Releases" → "Create a new release"
3. Settings:
   • Tag: v1.0.0
   • Title: Initial Release v1.0.0
   • Description: (use template below)

Release Description Template:

# 🎉 HunyuanImage-3.0 ComfyUI Nodes - Initial Release

Professional custom nodes for running Tencent's HunyuanImage-3.0 (80B parameter) model in ComfyUI.

## ✨ Key Features

- 🔧 **Multiple Loader Modes**: Full BF16, NF4 Quantized, Multi-GPU, Single-GPU optimized
- 🧠 **Smart Memory Management**: Automatic VRAM tracking, cleanup, and optimization
- 🎨 **Advanced Generation**: 
  - Standard (<2MP) and Large (2-8MP+) generation nodes
  - Automatic prompt enhancement via DeepSeek API
  - Negative prompt support
- 📐 **Organized Resolutions**: Clear portrait/landscape labels with megapixel indicators
- 🔥 **CPU Offload Support**: Generate large images without OOM errors
- 📊 **Production Ready**: Comprehensive error handling and detailed logging

## 📥 Installation

See [README.md](https://github.com/YOUR_USERNAME/Eric_Hunyuan3#installation) for full instructions.

Quick install:
```bash
cd ComfyUI/custom_nodes
git clone https://github.com/ericRollei/Eric_Hunyuan3.git
cd Eric_Hunyuan3
pip install -r requirements.txt
# Download model, restart ComfyUI

💻 Requirements

• Minimum: 24GB VRAM (NF4 quantized)
• Recommended: 80GB+ VRAM or multi-GPU (full BF16)
• CUDA 12.8+
• PyTorch 2.7+

📚 Documentation

• Main README - Complete usage guide
• Quantization Guide - NF4 quantization instructions
• Contributing - How to contribute

🙏 Credits

• Tencent Hunyuan Team for HunyuanImage-3.0
• ComfyUI Community for the framework
• All contributors and testers

---

Full Changelog: Initial release

## 🎯 Post-Publishing

### 1. Submit to ComfyUI Manager
Create a PR to: https://github.com/ltdrdata/ComfyUI-Manager
- Add your node to the custom node list
- Include description and installation instructions

### 2. Share the News
- [ ] Post on r/StableDiffusion
- [ ] Post on r/comfyui  
- [ ] Share in ComfyUI Discord
- [ ] Tweet with tags: #ComfyUI #HunyuanImage #AI #StableDiffusion

### 3. Monitor
- [ ] Watch for Issues
- [ ] Respond to questions
- [ ] Accept helpful PRs
- [ ] Update docs based on feedback

## 🐛 Troubleshooting

**"Model files showing in git status":**
- Check .gitignore includes `*.safetensors` and `*.bin`
- Run: `git rm --cached *.safetensors` (if already tracked)

**"Too many files":**
- Verify __pycache__ is excluded
- Check no large test files included

**"Clone failing":**
- Ensure repository is public
- Check URL is correct
- Verify git is installed

## 📝 Version Numbering

Use semantic versioning: `MAJOR.MINOR.PATCH`

- **MAJOR**: Breaking changes
- **MINOR**: New features (backwards compatible)
- **PATCH**: Bug fixes

Example: `v1.0.0` → `v1.1.0` (new feature) → `v1.1.1` (bug fix)

## ✅ Final Check

Before pushing to GitHub:
- [ ] No model files in repo
- [ ] No personal info in code
- [ ] README links updated
- [ ] License is correct
- [ ] .gitignore is working
- [ ] All nodes load in ComfyUI
- [ ] Test generation works

---

## 🎊 Ready to Publish!

Once all checkboxes are complete, you're ready to share your nodes with the world!

**Good luck!** 🚀