Skip to content

Commit 413f031

Browse files
authored
Added performance issue template
1 parent d556f0d commit 413f031

File tree

1 file changed

+123
-0
lines changed

1 file changed

+123
-0
lines changed
Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
name: "⚡ Performance Issue"
2+
description: "Report a performance degradation or inefficiency in a Vega UI component"
3+
title: "[Perf] <ComponentName>: short summary"
4+
labels: ["performance", "ui-kit", "investigation"]
5+
assignees:
6+
- core-team
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
## ⚡ Vega UI Performance Issue Report
13+
Please use this template to report performance regressions, inefficiencies, or rendering bottlenecks in Vega UI components.
14+
15+
- type: input
16+
id: component
17+
attributes:
18+
label: Component
19+
description: Exact component name (e.g., ButtonBase, Accordion, AvatarGroup)
20+
placeholder: "ButtonBase"
21+
validations:
22+
required: true
23+
24+
- type: dropdown
25+
id: severity
26+
attributes:
27+
label: Severity level
28+
description: How much does the issue impact UX or system performance?
29+
options:
30+
- 🟥 Critical (UI freeze, severe lag, blocking user interaction)
31+
- 🟧 High (noticeable delay in normal user flow)
32+
- 🟨 Medium (visible only under heavy load or many instances)
33+
- 🟩 Low (minor measurable impact)
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: context
39+
attributes:
40+
label: Context
41+
description: Describe where and under what conditions the issue occurs (platform, device, environment, etc.)
42+
placeholder: |
43+
Example:
44+
• Vega UI Web
45+
• Component: ListItem
46+
• Issue: FPS drops during scrolling with 1000+ list items
47+
48+
- type: textarea
49+
id: metrics
50+
attributes:
51+
label: Metrics and profiling data
52+
description: Provide any measurement data (FPS, memory usage, render count, commit time, etc.)
53+
placeholder: |
54+
Example:
55+
• FPS drops 60 → 28 during scroll
56+
• Re-renders: 200+ per state update
57+
• Memory usage: 120 MB → 300 MB in 10s
58+
59+
- type: textarea
60+
id: reproduction
61+
attributes:
62+
label: Steps to reproduce
63+
description: Provide clear steps for reproducing the issue
64+
placeholder: |
65+
1. Open the ButtonBase story in Storybook
66+
2. Start React Profiler
67+
3. Click the button repeatedly
68+
4. Observe render time increase
69+
70+
- type: textarea
71+
id: expected
72+
attributes:
73+
label: Expected behavior
74+
description: Describe how the component should ideally perform
75+
placeholder: "Component should only re-render itself, not sibling elements"
76+
77+
- type: textarea
78+
id: actual
79+
attributes:
80+
label: Actual behavior
81+
description: Describe what actually happens during performance degradation
82+
placeholder: "Every click triggers a re-render of the entire list"
83+
84+
- type: dropdown
85+
id: profiling_tool
86+
attributes:
87+
label: Profiling tools used
88+
description: Which tools were used to collect data?
89+
multiple: true
90+
options:
91+
- React Profiler
92+
- Chrome Performance Tab
93+
- React Native Performance Monitor
94+
- Hermes Debugger
95+
- Lighthouse
96+
- Vega Benchmark Script
97+
- Other
98+
99+
- type: textarea
100+
id: screenshots
101+
attributes:
102+
label: Screenshots or profiling traces
103+
description: Attach screenshots or links to profiler traces
104+
placeholder: "Attach React Profiler trace or Lighthouse report link"
105+
106+
- type: textarea
107+
id: suggestions
108+
attributes:
109+
label: Possible causes or optimization ideas
110+
description: Share hypotheses or ideas for potential optimization
111+
placeholder: |
112+
Possible improvements:
113+
• Use React.memo
114+
• Optimize useEffect dependencies
115+
• Replace inline functions with useCallback
116+
• Add virtualization for large lists
117+
118+
- type: textarea
119+
id: additional
120+
attributes:
121+
label: Additional information
122+
description: Anything else useful for debugging (related PRs, commits, branches, etc.)
123+
placeholder: "Related commits, branches, or references"

0 commit comments

Comments
 (0)