Add PR submission checklist and screenshot recommendations

This commit is contained in:
John-Caldwell 2025-11-10 17:21:41 -06:00
parent 1a56b1dcea
commit 2bfd78c46a

109
PR_SUBMISSION_CHECKLIST.md Normal file
View File

@ -0,0 +1,109 @@
# 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
- [x] Plan document included
- [x] Code tested
- [ ] Screenshots captured (optional but recommended)
- [ ] Final review of PR description
- [ ] Ready to submit to upstream repository
## Submission Steps
1. **Push branch to your fork**:
```bash
git push origin preinstall-enhancements
```
2. **Create PR on GitHub**:
- Go to the upstream repository
- Click "New Pull Request"
- Select `preinstall-enhancements` as source branch
- Select `master` as target branch
- Copy PR description from `PR_DESCRIPTION.md`
- Add screenshots if available
- Submit PR
3. **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