mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-03-07 06:00:03 +00:00
132 lines
3.3 KiB
Markdown
132 lines
3.3 KiB
Markdown
# Create PR
|
|
|
|
Automate PR creation with proper tags, labels, and concise summary.
|
|
|
|
## Step 1: Check Prerequisites
|
|
|
|
```bash
|
|
# 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 functionality
|
|
- `area:workflows` - Workflow management
|
|
- `area:queue` - Queue system
|
|
- `area:models` - Model handling
|
|
- `area:templates` - Template system
|
|
- `area:subgraph` - Subgraph functionality
|
|
|
|
**UI Components**
|
|
|
|
- `area:ui` - General user interface improvements
|
|
- `area:widgets` - Widget system
|
|
- `area:dom-widgets` - DOM-based widgets
|
|
- `area:links` - Connection links between nodes
|
|
- `area:groups` - Node grouping functionality
|
|
- `area:reroutes` - Reroute nodes
|
|
- `area:previews` - Preview functionality
|
|
- `area:minimap` - Minimap navigation
|
|
- `area:floating-toolbox` - Floating toolbar
|
|
- `area:mask-editor` - Mask editing tools
|
|
|
|
**Navigation & Organization**
|
|
|
|
- `area:navigation` - Navigation system
|
|
- `area:search` - Search functionality
|
|
- `area:workspace-management` - Workspace features
|
|
- `area:topbar-menu` - Top bar menu
|
|
- `area:help-menu` - Help menu system
|
|
|
|
**System Features**
|
|
|
|
- `area:settings` - Settings/preferences
|
|
- `area:hotkeys` - Keyboard shortcuts
|
|
- `area:undo-redo` - Undo/redo system
|
|
- `area:customization` - Customization features
|
|
- `area:auth` - Authentication
|
|
- `area:comms` - Communication/networking
|
|
|
|
**Development & Infrastructure**
|
|
|
|
- `area:CI/CD` - CI/CD pipeline
|
|
- `area:testing` - Testing infrastructure
|
|
- `area:vue-migration` - Vue migration work
|
|
- `area:manager` - ComfyUI Manager integration
|
|
|
|
**Platform-Specific**
|
|
|
|
- `area:mobile` - Mobile support
|
|
- `area:3d` - 3D-related features
|
|
|
|
**Special Areas**
|
|
|
|
- `area:i18n` - Translation/internationalization
|
|
- `area:CNR` - Comfy Node Registry
|
|
|
|
## Step 3: Execute PR Creation
|
|
|
|
```bash
|
|
# 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`
|