|
| 1 | +# Create PR |
| 2 | + |
| 3 | +Automate PR creation with proper tags, labels, and concise summary. |
| 4 | + |
| 5 | +## Step 1: Check Prerequisites |
| 6 | + |
| 7 | +```bash |
| 8 | +# Ensure you have uncommitted changes |
| 9 | +git status |
| 10 | + |
| 11 | +# If changes exist, commit them first |
| 12 | +git add . |
| 13 | +git commit -m "[tag] Your commit message" |
| 14 | +``` |
| 15 | + |
| 16 | +## Step 2: Push and Create PR |
| 17 | + |
| 18 | +You'll create the PR with the following structure: |
| 19 | + |
| 20 | +### PR Tags (use in title) |
| 21 | + |
| 22 | +- `[feat]` - New features → label: `enhancement` |
| 23 | +- `[bugfix]` - Bug fixes → label: `verified bug` |
| 24 | +- `[refactor]` - Code restructuring → label: `enhancement` |
| 25 | +- `[docs]` - Documentation → label: `documentation` |
| 26 | +- `[test]` - Test changes → label: `enhancement` |
| 27 | +- `[ci]` - CI/CD changes → label: `enhancement` |
| 28 | + |
| 29 | +### Label Mapping |
| 30 | + |
| 31 | +#### General Labels |
| 32 | + |
| 33 | +- Feature/Enhancement: `enhancement` |
| 34 | +- Bug fixes: `verified bug` |
| 35 | +- Documentation: `documentation` |
| 36 | +- Dependencies: `dependencies` |
| 37 | +- Performance: `Performance` |
| 38 | +- Desktop app: `Electron` |
| 39 | + |
| 40 | +#### Product Area Labels |
| 41 | + |
| 42 | +**Core Features** |
| 43 | + |
| 44 | +- `area:nodes` - Node-related functionality |
| 45 | +- `area:workflows` - Workflow management |
| 46 | +- `area:queue` - Queue system |
| 47 | +- `area:models` - Model handling |
| 48 | +- `area:templates` - Template system |
| 49 | +- `area:subgraph` - Subgraph functionality |
| 50 | + |
| 51 | +**UI Components** |
| 52 | + |
| 53 | +- `area:ui` - General user interface improvements |
| 54 | +- `area:widgets` - Widget system |
| 55 | +- `area:dom-widgets` - DOM-based widgets |
| 56 | +- `area:links` - Connection links between nodes |
| 57 | +- `area:groups` - Node grouping functionality |
| 58 | +- `area:reroutes` - Reroute nodes |
| 59 | +- `area:previews` - Preview functionality |
| 60 | +- `area:minimap` - Minimap navigation |
| 61 | +- `area:floating-toolbox` - Floating toolbar |
| 62 | +- `area:mask-editor` - Mask editing tools |
| 63 | + |
| 64 | +**Navigation & Organization** |
| 65 | + |
| 66 | +- `area:navigation` - Navigation system |
| 67 | +- `area:search` - Search functionality |
| 68 | +- `area:workspace-management` - Workspace features |
| 69 | +- `area:topbar-menu` - Top bar menu |
| 70 | +- `area:help-menu` - Help menu system |
| 71 | + |
| 72 | +**System Features** |
| 73 | + |
| 74 | +- `area:settings` - Settings/preferences |
| 75 | +- `area:hotkeys` - Keyboard shortcuts |
| 76 | +- `area:undo-redo` - Undo/redo system |
| 77 | +- `area:customization` - Customization features |
| 78 | +- `area:auth` - Authentication |
| 79 | +- `area:comms` - Communication/networking |
| 80 | + |
| 81 | +**Development & Infrastructure** |
| 82 | + |
| 83 | +- `area:CI/CD` - CI/CD pipeline |
| 84 | +- `area:testing` - Testing infrastructure |
| 85 | +- `area:vue-migration` - Vue migration work |
| 86 | +- `area:manager` - ComfyUI Manager integration |
| 87 | + |
| 88 | +**Platform-Specific** |
| 89 | + |
| 90 | +- `area:mobile` - Mobile support |
| 91 | +- `area:3d` - 3D-related features |
| 92 | + |
| 93 | +**Special Areas** |
| 94 | + |
| 95 | +- `area:i18n` - Translation/internationalization |
| 96 | +- `area:CNR` - Comfy Node Registry |
| 97 | + |
| 98 | +## Step 3: Execute PR Creation |
| 99 | + |
| 100 | +```bash |
| 101 | +# First, push your branch |
| 102 | +git push -u origin $(git branch --show-current) |
| 103 | + |
| 104 | +# Then create the PR (replace placeholders) |
| 105 | +gh pr create \ |
| 106 | + --title "[TAG] Brief description" \ |
| 107 | + --body "$(cat <<'EOF' |
| 108 | +## Summary |
| 109 | +One sentence describing what changed and why. |
| 110 | +
|
| 111 | +## Changes |
| 112 | +- **What**: Core functionality added/modified |
| 113 | +- **Breaking**: Any breaking changes (if none, omit this line) |
| 114 | +- **Dependencies**: New dependencies (if none, omit this line) |
| 115 | +
|
| 116 | +## Review Focus |
| 117 | +- Critical design decisions or edge cases that need attention |
| 118 | +
|
| 119 | +Fixes #ISSUE_NUMBER |
| 120 | +EOF |
| 121 | +)" \ |
| 122 | + --label "APPROPRIATE_LABEL" \ |
| 123 | + --base main |
| 124 | +``` |
| 125 | + |
| 126 | +## Additional Options |
| 127 | + |
| 128 | +- Add multiple labels: `--label "enhancement,Performance"` |
| 129 | +- Request reviewers: `--reviewer @username` |
| 130 | +- Mark as draft: `--draft` |
| 131 | +- Open in browser after creation: `--web` |
0 commit comments