Skip to content

Commit 70abc06

Browse files
committed
MNT: Update issue templates
* Don't submit perfunctory form fields. * Don't break on Markdown newlines.
1 parent fe9d9a8 commit 70abc06

File tree

3 files changed

+41
-45
lines changed

3 files changed

+41
-45
lines changed

.github/ISSUE_TEMPLATE/1-bug.yml

+21-23
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,31 @@ title: "Short title loaded with keywords"
44
body:
55
- type: markdown
66
attributes:
7-
value: |
7+
value: >+
88
Thanks for putting in the effort to submit this bug report! Note, the
99
best bug reports are accompanied with fixing patches / pull-requests. 🙏
1010
11-
- type: checkboxes
11+
- type: markdown
1212
attributes:
13-
label: Contributing guidelines
14-
description: |
15-
Please kindly follow this project's
16-
[Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md).
17-
The guidelines contain short technical notes on how to best contribute to this project.
18-
options:
19-
- label: |
20-
I agree to follow this project's
21-
[Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md)
22-
which, I understand, contain short technical notes on how to best contribute to this project.
23-
required: true
13+
value: >+
14+
**Contributing guidelines** $\color{red}{*}$
2415
25-
- type: checkboxes
16+
- [x] I agree to follow this project's
17+
[Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md)
18+
which, I understand, contain short technical notes on how to best contribute to this project.
19+
20+
- type: markdown
2621
attributes:
27-
label: Own due diligence
28-
options:
29-
- label: |
30-
I verify my due dilligence—I have went through the **tutorials** and the **API docs** and
31-
have used the **search** on **Issues** and GitHub **Disucussions**, as well all Google,
32-
with all the relevant search keywords.
33-
required: true
22+
value: >+
23+
**Own due diligence** $\color{red}{*}$
24+
25+
- [x] I verify my due dilligence—I have went through the
26+
[**tutorials**](https://kernc.github.io/backtesting.py/doc/backtesting/#manuals) and the
27+
[**API docs**](https://kernc.github.io/backtesting.py/doc/backtesting/backtesting.html) and
28+
have used the
29+
[**search** on **Issues**](https://github.com/kernc/backtesting.py/issues?q=(is%3Aissue%20OR%20is%3Apr)%20) and
30+
[GitHub **Disucussions**](https://github.com/kernc/backtesting.py/discussions), as well as Google,
31+
with all the relevant search keywords that also comprise the title (see above) of the new issue I'm opening.
3432
3533
- type: textarea
3634
id: expected
@@ -39,7 +37,7 @@ body:
3937
attributes:
4038
label: Expected behavior
4139
description: You run the code below and expect what to happen?
42-
placeholder: When I run this code ... the program should ...
40+
placeholder: When I run the code below ... the program should ...
4341

4442
- type: textarea
4543
id: code
@@ -53,7 +51,7 @@ body:
5351
from backtesting import Backtest, Strategy
5452
from backtesting.test import GOOG
5553
56-
class Example(Strategy):
54+
class MinimalExample(Strategy):
5755
...
5856
5957
bt = Backtest(GOOG, Example)

.github/ISSUE_TEMPLATE/2-enh.yml

+19-21
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,30 @@ labels: ["enhancement"]
55
body:
66
- type: markdown
77
attributes:
8-
value: |
8+
value: >+
99
Thanks for taking the time to give feedback on this software!
1010
11-
- type: checkboxes
11+
- type: markdown
1212
attributes:
13-
label: Contributing guidelines
14-
description: |
15-
Please kindly follow this project's
16-
[Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md).
17-
The guidelines contain short technical notes on how to best contribute to this project.
18-
options:
19-
- label: |
20-
I agree to follow this project's
21-
[Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md)
22-
which, I understand, contain short technical notes on how to best contribute to this project.
23-
required: true
13+
value: >+
14+
**Contributing guidelines** $\color{red}{*}$
15+
16+
- [x] I agree to follow this project's
17+
[Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md)
18+
which, I understand, contain short technical notes on how to best contribute to this project.
2419
25-
- type: checkboxes
20+
- type: markdown
2621
attributes:
27-
label: Own due diligence
28-
options:
29-
- label: |
30-
I verify my due dilligence—I have went through the **tutorials** and the **API docs** and
31-
have used the **search** on **Issues** and GitHub **Disucussions**, as well all Google,
32-
with all the relevant search keywords.
33-
required: true
22+
value: >+
23+
**Own due diligence** $\color{red}{*}$
24+
25+
- [x] I verify my due dilligence—I have went through the
26+
[**tutorials**](https://kernc.github.io/backtesting.py/doc/backtesting/#manuals) and the
27+
[**API docs**](https://kernc.github.io/backtesting.py/doc/backtesting/backtesting.html) and
28+
have used the
29+
[**search** on **Issues**](https://github.com/kernc/backtesting.py/issues?q=(is%3Aissue%20OR%20is%3Apr)%20) and
30+
[GitHub **Disucussions**](https://github.com/kernc/backtesting.py/discussions), as well as Google,
31+
with all the relevant search keywords to ensure this feature request hadn't been filed or answered before.
3432
3533
- type: textarea
3634
id: expected

backtesting/_plotting.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -728,7 +728,7 @@ def plot_heatmaps(heatmap: pd.Series, agg: Union[Callable, str], ncols: int,
728728
param_combinations = combinations(heatmap.index.names, 2)
729729
dfs = [heatmap.groupby(list(dims)).agg(agg).to_frame(name='_Value')
730730
for dims in param_combinations]
731-
figs = []
731+
figs: list[_figure] = []
732732
cmap = LinearColorMapper(palette='Viridis256',
733733
low=min(df.min().min() for df in dfs),
734734
high=max(df.max().max() for df in dfs),

0 commit comments

Comments
 (0)