mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-03-03 04:00:31 +00:00
Add Storybook issue template and tracking documentation
Co-authored-by: snomiao <7323030+snomiao@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
96
.github/ISSUE_TEMPLATE/storybook-improvement.yaml
vendored
Normal file
96
.github/ISSUE_TEMPLATE/storybook-improvement.yaml
vendored
Normal file
@@ -0,0 +1,96 @@
|
||||
name: Storybook Improvement
|
||||
description: 'Report Storybook-related improvements, new stories, or configuration issues'
|
||||
title: '[Storybook]: '
|
||||
labels: ['area:storybook', 'enhancement']
|
||||
type: Storybook
|
||||
|
||||
body:
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Prerequisites
|
||||
options:
|
||||
- label: I have checked the existing Storybook documentation in `.storybook/`
|
||||
required: true
|
||||
- label: I have searched existing issues to make sure this isn't a duplicate
|
||||
required: true
|
||||
- label: I have checked if this relates to any existing Storybook PRs
|
||||
|
||||
- type: dropdown
|
||||
id: category
|
||||
attributes:
|
||||
label: Category
|
||||
description: What type of Storybook improvement is this?
|
||||
options:
|
||||
- Component Stories - Add new stories for existing components
|
||||
- Story Enhancement - Improve existing stories
|
||||
- Configuration - Storybook configuration improvements
|
||||
- Visual Testing - Chromatic/visual regression testing
|
||||
- Documentation - Storybook documentation improvements
|
||||
- Build/Performance - Build optimizations or performance improvements
|
||||
- Theme/Styling - Theme support or styling improvements
|
||||
- Tools/Addons - Storybook addons or tool integration
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: What improvement are you suggesting?
|
||||
description: Describe the Storybook improvement you'd like to see
|
||||
placeholder: |
|
||||
Example: "Add comprehensive stories for the NodeWidget component covering all widget types (text, number, combo, etc.) to improve component development and testing."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Use Case & Context
|
||||
description: Why is this improvement needed? What problem does it solve?
|
||||
placeholder: |
|
||||
- Current state of the component/story
|
||||
- What's missing or could be improved
|
||||
- How this would benefit development workflow
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: priority
|
||||
attributes:
|
||||
label: Priority
|
||||
description: How important is this improvement?
|
||||
options:
|
||||
- Low - Nice to have enhancement
|
||||
- Medium - Would improve development workflow
|
||||
- High - Important for component quality/testing
|
||||
- Critical - Needed for proper Storybook functionality
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: components
|
||||
attributes:
|
||||
label: Components Affected
|
||||
description: Which components or areas would be affected by this improvement?
|
||||
placeholder: |
|
||||
- NodeWidget
|
||||
- Settings components
|
||||
- All button components
|
||||
- etc.
|
||||
|
||||
- type: textarea
|
||||
id: implementation
|
||||
attributes:
|
||||
label: Implementation Ideas (Optional)
|
||||
description: Any ideas on how this could be implemented?
|
||||
placeholder: |
|
||||
- Specific stories to create
|
||||
- Configuration changes needed
|
||||
- Dependencies or tools required
|
||||
|
||||
- type: textarea
|
||||
id: examples
|
||||
attributes:
|
||||
label: Examples or References
|
||||
description: Any examples from other projects, screenshots, or links that help illustrate the improvement
|
||||
121
STORYBOOK_TRACKING_ISSUE.md
Normal file
121
STORYBOOK_TRACKING_ISSUE.md
Normal file
@@ -0,0 +1,121 @@
|
||||
# 📚 Storybook Development Tracking
|
||||
|
||||
This issue serves as a central hub for tracking all Storybook-related PRs and improvements in the ComfyUI Frontend repository.
|
||||
|
||||
## 🎯 Overview
|
||||
|
||||
Storybook is a crucial part of our component development workflow, enabling:
|
||||
- Component isolation and development
|
||||
- Visual documentation and testing
|
||||
- Automated visual regression testing with Chromatic
|
||||
- Design system development and maintenance
|
||||
|
||||
## 📈 Current Status
|
||||
|
||||
**Storybook Setup**: ✅ Complete
|
||||
**Component Coverage**: 🔄 In Progress
|
||||
**Visual Testing**: ✅ Integrated with Chromatic
|
||||
**Documentation**: ✅ Comprehensive guides available
|
||||
|
||||
## 📋 Storybook PRs by Category
|
||||
|
||||
### 🏗️ Initial Setup & Infrastructure
|
||||
- **#4861** - [feat] Add Storybook setup and NodePreview story *(merged)*
|
||||
- Complete Storybook v8 setup with Vue 3 + Vite
|
||||
- Chromatic integration for visual testing
|
||||
- Comprehensive documentation and guidelines
|
||||
|
||||
### 📖 Component Stories & Documentation
|
||||
- **#4999** - [feat] 100+ more Stories for Common Components *(open)*
|
||||
- 76 story variants across 11 components
|
||||
- Covers STATIC → SIMPLE_PROPS → INTERACTIVE → COMPLEX tiers
|
||||
- **#5034** - [feat] Add Storybook configuration and settings panel stories *(open)*
|
||||
- Settings panel components with all input types
|
||||
- Responsive design and accessibility features
|
||||
- **#5098** - [feat] Add comprehensive Storybook stories for custom UI components *(open)*
|
||||
- 12 custom UI components with interactive testing
|
||||
- Button, input, and layout component stories
|
||||
- **#5122** - [docs] Add Storybook documentation *(open)*
|
||||
- Enhanced `.storybook/README.md` with comprehensive guidelines
|
||||
|
||||
### 🎨 Theme & Visual Improvements
|
||||
- **#5088** - [feat] Add dark theme support for Storybook *(merged)*
|
||||
- Dark theme toggle with persistence
|
||||
- Smooth transitions and proper styling
|
||||
|
||||
### 🔧 Configuration & Build Optimizations
|
||||
- **#5117** - [ci] Enhance CI/CD caching across all workflows *(open)*
|
||||
- Improved caching for Storybook builds
|
||||
- **#5118** - [ci] Add retry logic to wrangler page deploy step *(open)*
|
||||
- Stability improvements for Storybook deployment
|
||||
|
||||
### 🚀 Features & Enhancements
|
||||
- **#5119** - [feat] Add enhanced filter UI components *(open)*
|
||||
- SearchBox integration and improved MultiSelect
|
||||
- **#5096** - [fix] Resolve breadcrumb and workflow tabs layout conflict *(open)*
|
||||
- Layout improvements affecting Storybook stories
|
||||
- **#5113** - [fix] Reposition TaskItem info *(open)*
|
||||
- Component fixes that impact Storybook examples
|
||||
|
||||
### 🔨 Technical Improvements & Fixes
|
||||
- **#5106** - Fix/widget ordering consistency *(open)*
|
||||
- Node widget improvements affecting stories
|
||||
- **#5109** - Fix CopyToClipboard Issue *(open)*
|
||||
- Component fixes relevant to Storybook examples
|
||||
- **#5092** - Add support for high-resolution wheel events *(open)*
|
||||
- Input handling improvements
|
||||
- **#5115** - Fix: Shift+Click+Drag from outputs with Subgraph outputs *(open)*
|
||||
- Node interaction improvements
|
||||
- **#5114** - Remove duplicate semantic labeling from issue templates *(open)*
|
||||
- Issue template improvements
|
||||
- **#5102** - [fix] Invoke onRemove callback in LGraphNode.removeWidget method *(merged)*
|
||||
- Widget system improvements
|
||||
- **#5099** - Remove PR checks workflows *(merged)*
|
||||
- CI/CD cleanup
|
||||
- **#5103** - Update to latest version of workflow icon *(merged)*
|
||||
- Icon updates affecting stories
|
||||
- **#5107** - [ci] Add caching support to format and knip commands *(merged)*
|
||||
- Build optimization improvements
|
||||
- **#5108** - [refactor] Remove obsolete Kontext Edit Button *(merged)*
|
||||
- Component cleanup
|
||||
- **#5110** - [chore] Ignore ./claude/settings.json *(merged)*
|
||||
- Development environment improvements
|
||||
- **#5112** - [docs] Update browser tests README *(merged)*
|
||||
- Testing documentation improvements
|
||||
- **#4908** - Modal Component & Custom UI Components *(merged)*
|
||||
- Foundation UI components used in stories
|
||||
|
||||
## 🎯 Upcoming Priorities
|
||||
|
||||
### High Priority
|
||||
- [ ] Complete component story coverage for all major UI components
|
||||
- [ ] Implement comprehensive visual regression testing
|
||||
- [ ] Improve Storybook build performance and caching
|
||||
|
||||
### Medium Priority
|
||||
- [ ] Add interactive component documentation
|
||||
- [ ] Enhance theme switching and customization
|
||||
- [ ] Improve mobile responsiveness of stories
|
||||
|
||||
### Low Priority
|
||||
- [ ] Add more sophisticated mock data patterns
|
||||
- [ ] Implement component testing automation
|
||||
- [ ] Explore advanced Storybook addons
|
||||
|
||||
## 🔄 How to Contribute
|
||||
|
||||
1. **Creating New Stories**: Follow guidelines in `.storybook/README.md` and `.storybook/CLAUDE.md`
|
||||
2. **Improving Existing Stories**: Use the Storybook Improvement issue template
|
||||
3. **Documentation**: Update relevant documentation when adding features
|
||||
4. **Testing**: Ensure all stories build and render correctly
|
||||
|
||||
## 📚 Resources
|
||||
|
||||
- **Storybook Documentation**: `.storybook/README.md`
|
||||
- **Developer Guidelines**: `.storybook/CLAUDE.md`
|
||||
- **Component Examples**: `src/components/*/\*.stories.ts`
|
||||
- **Visual Testing**: Chromatic integration in CI/CD
|
||||
|
||||
---
|
||||
|
||||
*This issue is automatically maintained. Please reference this issue number when working on Storybook-related improvements.*
|
||||
Reference in New Issue
Block a user