mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-01-26 19:09:52 +00:00
3.3 KiB
3.3 KiB
Create PR
Automate PR creation with proper tags, labels, and concise summary.
Step 1: Check Prerequisites
# Ensure you have uncommitted changes
git status
# If changes exist, commit them first
git add .
git commit -m "[tag] Your commit message"
Step 2: Push and Create PR
You'll create the PR with the following structure:
PR Tags (use in title)
[feat]- New features → label:enhancement[bugfix]- Bug fixes → label:verified bug[refactor]- Code restructuring → label:enhancement[docs]- Documentation → label:documentation[test]- Test changes → label:enhancement[ci]- CI/CD changes → label:enhancement
Label Mapping
General Labels
- Feature/Enhancement:
enhancement - Bug fixes:
verified bug - Documentation:
documentation - Dependencies:
dependencies - Performance:
Performance - Desktop app:
Electron
Product Area Labels
Core Features
area:nodes- Node-related functionalityarea:workflows- Workflow managementarea:queue- Queue systemarea:models- Model handlingarea:templates- Template systemarea:subgraph- Subgraph functionality
UI Components
area:ui- General user interface improvementsarea:widgets- Widget systemarea:dom-widgets- DOM-based widgetsarea:links- Connection links between nodesarea:groups- Node grouping functionalityarea:reroutes- Reroute nodesarea:previews- Preview functionalityarea:minimap- Minimap navigationarea:floating-toolbox- Floating toolbararea:mask-editor- Mask editing tools
Navigation & Organization
area:navigation- Navigation systemarea:search- Search functionalityarea:workspace-management- Workspace featuresarea:topbar-menu- Top bar menuarea:help-menu- Help menu system
System Features
area:settings- Settings/preferencesarea:hotkeys- Keyboard shortcutsarea:undo-redo- Undo/redo systemarea:customization- Customization featuresarea:auth- Authenticationarea:comms- Communication/networking
Development & Infrastructure
area:CI/CD- CI/CD pipelinearea:testing- Testing infrastructurearea:vue-migration- Vue migration workarea:manager- ComfyUI Manager integration
Platform-Specific
area:mobile- Mobile supportarea:3d- 3D-related features
Special Areas
area:i18n- Translation/internationalizationarea:CNR- Comfy Node Registry
Step 3: Execute PR Creation
# First, push your branch
git push -u origin $(git branch --show-current)
# Then create the PR (replace placeholders)
gh pr create \
--title "[TAG] Brief description" \
--body "$(cat <<'EOF'
## Summary
One sentence describing what changed and why.
## Changes
- **What**: Core functionality added/modified
- **Breaking**: Any breaking changes (if none, omit this line)
- **Dependencies**: New dependencies (if none, omit this line)
## Review Focus
- Critical design decisions or edge cases that need attention
Fixes #ISSUE_NUMBER
EOF
)" \
--label "APPROPRIATE_LABEL" \
--base main
Additional Options
- Add multiple labels:
--label "enhancement,Performance" - Request reviewers:
--reviewer @username - Mark as draft:
--draft - Open in browser after creation:
--web