Skip to content

Commit 7a1dcd5

Browse files
MDUYNMDUYN
committed
Add improve chart templates
1 parent 5a2c4c2 commit 7a1dcd5

2 files changed

Lines changed: 230 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/improve-chart.yml‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
name: "📊 Improve Documentation Chart"
2+
description: "Request an improved or new chart for an indicator's documentation page"
3+
title: "[Chart] "
4+
labels: ["squad", "docs", "chart"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Documentation Chart Improvement
10+
Use this template to request a new or improved chart for an indicator's documentation page.
11+
**Include reference screenshots** showing what the chart should look like.
12+
13+
- type: input
14+
id: indicator-name
15+
attributes:
16+
label: Indicator Name
17+
description: "Which indicator's documentation needs a chart update?"
18+
placeholder: "e.g., SuperTrend, RSI, Trendline Breakout Navigator"
19+
validations:
20+
required: true
21+
22+
- type: input
23+
id: docs-page
24+
attributes:
25+
label: Current Docs Page
26+
description: "Path to the existing docs page (if it exists)"
27+
placeholder: "e.g., docs/content/indicators/trend/supertrend.md"
28+
validations:
29+
required: false
30+
31+
- type: dropdown
32+
id: chart-type
33+
attributes:
34+
label: What needs to happen?
35+
options:
36+
- Add a new chart (no chart exists yet)
37+
- Replace existing chart (current one is wrong or ugly)
38+
- Add additional chart (show a different view or timeframe)
39+
- Fix chart rendering issue
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: reference-chart
45+
attributes:
46+
label: Reference Chart(s)
47+
description: |
48+
**Paste or drag & drop screenshots** of what the chart should look like.
49+
Include charts from TradingView, other platforms, or hand-drawn sketches — anything that shows the desired result.
50+
placeholder: "Drag and drop images here..."
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: chart-description
56+
attributes:
57+
label: Chart Description
58+
description: |
59+
**Describe the chart in detail** — agents may not always be able to see images.
60+
Include: what data is shown, what the indicator lines/zones look like, colors, key visual features.
61+
placeholder: |
62+
- Chart type: Candlestick with overlay
63+
- Indicator display: Two bands (upper green, lower red) with fill between them
64+
- Signals: Triangle markers at crossover points
65+
- Timeframe shown: 6 months of daily data
66+
- The chart should clearly show a trend reversal around the middle
67+
- ...
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: data-source
73+
attributes:
74+
label: Data Source
75+
description: "What data should the chart use?"
76+
placeholder: |
77+
- Asset: BTC/USD
78+
- Timeframe: Daily
79+
- Date range: 2024-01-01 to 2024-12-31
80+
- Or: use existing test data from resources/data/
81+
validations:
82+
required: false
83+
84+
- type: textarea
85+
id: chart-requirements
86+
attributes:
87+
label: Chart Requirements
88+
description: "Any specific requirements for the chart?"
89+
placeholder: |
90+
- Library: plotly (for interactive) or matplotlib (for static)
91+
- Include: buy/sell signal annotations
92+
- Color scheme: green for bullish, red for bearish
93+
- Export as: static image for docs + interactive HTML
94+
validations:
95+
required: false
96+
97+
- type: checkboxes
98+
id: deliverables
99+
attributes:
100+
label: Deliverables
101+
description: "What needs to be delivered?"
102+
options:
103+
- label: "Static chart image for docs page (PNG/SVG in `static/images/`)"
104+
- label: "Update docs page to include the chart"
105+
- label: "Analysis notebook with interactive plotly chart"
106+
- label: "HTML export of interactive chart"
107+
108+
- type: textarea
109+
id: additional-context
110+
attributes:
111+
label: Additional Context
112+
description: "Anything else? What's wrong with the current chart? Specific style preferences?"
113+
placeholder: "Optional additional context..."
114+
validations:
115+
required: false

‎.squad/templates/improve-chart-issue.yml‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
name: "📊 Improve Documentation Chart"
2+
description: "Request an improved or new chart for an indicator's documentation page"
3+
title: "[Chart] "
4+
labels: ["squad", "docs", "chart"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Documentation Chart Improvement
10+
Use this template to request a new or improved chart for an indicator's documentation page.
11+
**Include reference screenshots** showing what the chart should look like.
12+
13+
- type: input
14+
id: indicator-name
15+
attributes:
16+
label: Indicator Name
17+
description: "Which indicator's documentation needs a chart update?"
18+
placeholder: "e.g., SuperTrend, RSI, Trendline Breakout Navigator"
19+
validations:
20+
required: true
21+
22+
- type: input
23+
id: docs-page
24+
attributes:
25+
label: Current Docs Page
26+
description: "Path to the existing docs page (if it exists)"
27+
placeholder: "e.g., docs/content/indicators/trend/supertrend.md"
28+
validations:
29+
required: false
30+
31+
- type: dropdown
32+
id: chart-type
33+
attributes:
34+
label: What needs to happen?
35+
options:
36+
- Add a new chart (no chart exists yet)
37+
- Replace existing chart (current one is wrong or ugly)
38+
- Add additional chart (show a different view or timeframe)
39+
- Fix chart rendering issue
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: reference-chart
45+
attributes:
46+
label: Reference Chart(s)
47+
description: |
48+
**Paste or drag & drop screenshots** of what the chart should look like.
49+
Include charts from TradingView, other platforms, or hand-drawn sketches — anything that shows the desired result.
50+
placeholder: "Drag and drop images here..."
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: chart-description
56+
attributes:
57+
label: Chart Description
58+
description: |
59+
**Describe the chart in detail** — agents may not always be able to see images.
60+
Include: what data is shown, what the indicator lines/zones look like, colors, key visual features.
61+
placeholder: |
62+
- Chart type: Candlestick with overlay
63+
- Indicator display: Two bands (upper green, lower red) with fill between them
64+
- Signals: Triangle markers at crossover points
65+
- Timeframe shown: 6 months of daily data
66+
- The chart should clearly show a trend reversal around the middle
67+
- ...
68+
validations:
69+
required: true
70+
71+
- type: textarea
72+
id: data-source
73+
attributes:
74+
label: Data Source
75+
description: "What data should the chart use?"
76+
placeholder: |
77+
- Asset: BTC/USD
78+
- Timeframe: Daily
79+
- Date range: 2024-01-01 to 2024-12-31
80+
- Or: use existing test data from resources/data/
81+
validations:
82+
required: false
83+
84+
- type: textarea
85+
id: chart-requirements
86+
attributes:
87+
label: Chart Requirements
88+
description: "Any specific requirements for the chart?"
89+
placeholder: |
90+
- Library: plotly (for interactive) or matplotlib (for static)
91+
- Include: buy/sell signal annotations
92+
- Color scheme: green for bullish, red for bearish
93+
- Export as: static image for docs + interactive HTML
94+
validations:
95+
required: false
96+
97+
- type: checkboxes
98+
id: deliverables
99+
attributes:
100+
label: Deliverables
101+
description: "What needs to be delivered?"
102+
options:
103+
- label: "Static chart image for docs page (PNG/SVG in `static/images/`)"
104+
- label: "Update docs page to include the chart"
105+
- label: "Analysis notebook with interactive plotly chart"
106+
- label: "HTML export of interactive chart"
107+
108+
- type: textarea
109+
id: additional-context
110+
attributes:
111+
label: Additional Context
112+
description: "Anything else? What's wrong with the current chart? Specific style preferences?"
113+
placeholder: "Optional additional context..."
114+
validations:
115+
required: false

0 commit comments

Comments
 (0)