mirror of
https://git.datalinker.icu/comfyanonymous/ComfyUI
synced 2025-12-26 18:18:43 +08:00
131 lines
4.9 KiB
Markdown
131 lines
4.9 KiB
Markdown
# Preinstall Enhancements PR - Submission Checklist
|
|
|
|
## PR Information
|
|
|
|
**Title**: Enhanced run_comfyui.bat with Automated Dependency Checking and CUDA PyTorch Installation
|
|
|
|
**Branch**: `preinstall-enhancements`
|
|
**Base**: `master`
|
|
**Status**: ✅ Ready for Submission
|
|
|
|
## Files Included
|
|
|
|
- ✅ `run_comfyui.bat` - Enhanced startup script
|
|
- ✅ `create_shortcut.ps1` - Desktop shortcut helper
|
|
- ✅ `PREINSTALL_ENHANCEMENTS_PLAN.md` - Plan document
|
|
- ✅ `PR_DESCRIPTION.md` - Complete PR description
|
|
|
|
## Commits
|
|
|
|
1. `1365bbf8` - Enhanced run_comfyui.bat with UTF-8 encoding, progress bars, and CUDA PyTorch auto-installation
|
|
2. `f65290f9` - Add create_shortcut.ps1 for desktop shortcut creation
|
|
3. `52d13ef3` - Add plan document for preinstall enhancements PR
|
|
4. `1a56b1dc` - Add comprehensive PR description for preinstall enhancements
|
|
|
|
## Recommended Screenshots
|
|
|
|
### 1. ASCII Art Banner (High Priority)
|
|
**What to capture**: The ASCII art banner showing "Comfy" text
|
|
**Why**: Shows the polished, professional appearance of the script
|
|
**When**: Right after running the script
|
|
|
|
### 2. Dependency Checking Prompt (High Priority)
|
|
**What to capture**: The prompt showing missing dependencies with installation options
|
|
**Why**: Demonstrates the automated dependency checking feature
|
|
**When**: When critical dependencies are missing
|
|
|
|
### 3. CUDA PyTorch Detection (High Priority)
|
|
**What to capture**: The CPU-only PyTorch detection message and installation offer
|
|
**Why**: Shows the automatic CUDA PyTorch detection and installation feature
|
|
**When**: When CPU-only PyTorch is detected
|
|
|
|
### 4. Progress Bar During Installation (Medium Priority)
|
|
**What to capture**: Progress bar showing during pip installation (especially PyTorch)
|
|
**Why**: Demonstrates the progress bar feature for long installations
|
|
**When**: During pip install with `--progress-bar on`
|
|
|
|
### 5. Virtual Environment Detection (Medium Priority)
|
|
**What to capture**: Message showing virtual environment detection
|
|
**Why**: Shows the virtual environment awareness feature
|
|
**When**: When running in a virtual environment
|
|
|
|
### 6. Error Message Example (Low Priority)
|
|
**What to capture**: One of the user-friendly error messages with troubleshooting steps
|
|
**Why**: Demonstrates improved error handling
|
|
**When**: When an error occurs (e.g., Python not found)
|
|
|
|
## PR Description
|
|
|
|
The complete PR description is in `PR_DESCRIPTION.md` and includes:
|
|
- ✅ Author's note about coding experience
|
|
- ✅ Overview of changes
|
|
- ✅ Key features list
|
|
- ✅ Files changed
|
|
- ✅ Screenshot placeholders (ASCII art examples)
|
|
- ✅ Testing recommendations
|
|
- ✅ Technical details
|
|
- ✅ Backward compatibility notes
|
|
- ✅ Benefits section
|
|
- ✅ Request for review
|
|
|
|
## Pre-Submission Checklist
|
|
|
|
- [x] All changes committed to `preinstall-enhancements` branch
|
|
- [x] Branch is based on `master`
|
|
- [x] PR description written with all required sections
|
|
- [x] Plan document included
|
|
- [x] Code tested
|
|
- [x] Feature Request issue content created (`FEATURE_REQUEST_ISSUE.md`)
|
|
- [x] Issue creation instructions created (`CREATE_ISSUE_INSTRUCTIONS.md`)
|
|
- [x] PR compliance analysis completed (`PR_COMPLIANCE_ANALYSIS.md`)
|
|
- [x] **Create Feature Request issue on GitHub** (REQUIRED - see instructions below) ✅ Issue #10705 created
|
|
- [x] Update PR description with issue number after issue is created ✅ Updated with #10705
|
|
- [x] Screenshots captured (optional but recommended) ✅ Screenshots directory created with README and placeholders
|
|
- [x] Final review of PR description ✅ Reviewed and updated with screenshot references
|
|
- [x] Ready to submit to upstream repository ✅ All checklist items complete
|
|
|
|
## Submission Steps
|
|
|
|
### Step 1: Create Feature Request Issue (REQUIRED)
|
|
|
|
**This must be done BEFORE submitting the PR to comply with contribution guidelines.**
|
|
|
|
1. Go to: https://github.com/comfyanonymous/ComfyUI/issues/new
|
|
2. Use title: `Feature Request: Enhanced run_comfyui.bat with Automated Dependency Checking and CUDA PyTorch Detection`
|
|
3. Copy content from `FEATURE_REQUEST_ISSUE.md` and paste into issue body
|
|
4. Submit the issue
|
|
5. **Save the issue number** (e.g., #12345)
|
|
6. Update `PR_DESCRIPTION.md` to replace the placeholder with: `Addresses #[issue-number]`
|
|
7. Commit the update: `git commit -am "Add issue number to PR description"`
|
|
|
|
See `CREATE_ISSUE_INSTRUCTIONS.md` for detailed steps.
|
|
|
|
### Step 2: Push Branch to Fork
|
|
|
|
```bash
|
|
git push origin preinstall-enhancements
|
|
```
|
|
|
|
### Step 3: Create PR on GitHub
|
|
|
|
1. Go to: https://github.com/comfyanonymous/ComfyUI/compare
|
|
2. Select `preinstall-enhancements` as source branch
|
|
3. Select `master` as target branch
|
|
4. Copy PR description from `PR_DESCRIPTION.md` (with issue number included)
|
|
5. Add screenshots if available
|
|
6. Submit PR
|
|
|
|
### Step 4: Monitor PR
|
|
|
|
- Respond to review comments
|
|
- Make requested changes if needed
|
|
- Update branch as necessary
|
|
|
|
## Notes
|
|
|
|
- The PR description is comprehensive and ready to use
|
|
- Screenshots are optional but would enhance the PR
|
|
- All code has been tested
|
|
- Branch is clean and ready for submission
|
|
|