Skip to content

Commit c79ffb0

Browse files
kernckernc
committed
MNT: Update issue templates
* Don't submit perfunctory form fields. * Don't break on Markdown newlines. * Put whole texts on single YAML lines because GitHub doesn't seem to support YAML "folded style" strings (`>`, ...) https://stackoverflow.com/questions/3790454/how-do-i-break-a-string-in-yaml-over-multiple-lines/21699210#21699210
1 parent fe9d9a8 commit c79ffb0

File tree

3 files changed

+29
-51
lines changed

3 files changed

+29
-51
lines changed

‎.github/ISSUE_TEMPLATE/1-bug.yml

+17-29
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,22 @@ title: "Short title loaded with keywords"
44
body:
55
- type: markdown
66
attributes:
7-
value: |
8-
Thanks for putting in the effort to submit this bug report! Note, the
9-
best bug reports are accompanied with fixing patches / pull-requests. 🙏
7+
value: >
8+
Thanks for putting in the effort to submit this bug report! Note, the best bug reports are accompanied with fixing patches / pull-requests. 🙏
109
11-
- type: checkboxes
10+
- type: markdown
1211
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
12+
value: >
13+
**Contributing guidelines** $\color{red}{*}$
14+
15+
- [x] I agree to follow this project's [Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md) which, I understand, contain short technical notes on how to best contribute to this project.
2416
25-
- type: checkboxes
17+
- type: markdown
2618
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
19+
value: >
20+
**Own due diligence** $\color{red}{*}$
21+
22+
- [x] I verify my due dilligence—I have went through the [**tutorials**](https://kernc.github.io/backtesting.py/doc/backtesting/#manuals) and the [**API docs**](https://kernc.github.io/backtesting.py/doc/backtesting/backtesting.html) and have used the [**search** on **Issues**](https://github.com/kernc/backtesting.py/issues?q=(is%3Aissue%20OR%20is%3Apr)%20) and [GitHub **Disucussions**](https://github.com/kernc/backtesting.py/discussions), as well as Google, with all the relevant search keywords that also comprise the title (see above) of the new issue I'm opening.
3423
3524
- type: textarea
3625
id: expected
@@ -39,7 +28,7 @@ body:
3928
attributes:
4029
label: Expected behavior
4130
description: You run the code below and expect what to happen?
42-
placeholder: When I run this code ... the program should ...
31+
placeholder: When I run the code below ... the program should ...
4332

4433
- type: textarea
4534
id: code
@@ -53,7 +42,7 @@ body:
5342
from backtesting import Backtest, Strategy
5443
from backtesting.test import GOOG
5544
56-
class Example(Strategy):
45+
class MinimalExample(Strategy):
5746
...
5847
5948
bt = Backtest(GOOG, Example)
@@ -74,9 +63,8 @@ body:
7463
required: false
7564
attributes:
7665
label: Additional info, steps to reproduce, full crash traceback, screenshots
77-
description: |
78-
Attach any additional info you think might be helpful and
79-
result in quicker resolution of your bug.
66+
description: >
67+
Attach any additional info you think might be helpful and result in quicker resolution of your bug.
8068
placeholder: |
8169
1. Do ...
8270
2. ...
@@ -89,7 +77,7 @@ body:
8977
required: false
9078
attributes:
9179
label: Software versions
92-
description: |
80+
description: >
9381
Versions of the relevant software / packages.
9482
value: |
9583
<!-- From `backtesting.__version__`. If git, use commit hash -->

‎.github/ISSUE_TEMPLATE/2-enh.yml

+11-21
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,22 @@ 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 [Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md) which, I understand, contain short technical notes on how to best contribute to this project.
2417
25-
- type: checkboxes
18+
- type: markdown
2619
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
20+
value: >+
21+
**Own due diligence** $\color{red}{*}$
22+
23+
- [x] I verify my due dilligence—I have went through the [**tutorials**](https://kernc.github.io/backtesting.py/doc/backtesting/#manuals) and the [**API docs**](https://kernc.github.io/backtesting.py/doc/backtesting/backtesting.html) and have used the [**search** on **Issues**](https://github.com/kernc/backtesting.py/issues?q=(is%3Aissue%20OR%20is%3Apr)%20) and [GitHub **Disucussions**](https://github.com/kernc/backtesting.py/discussions), as well as Google, with all the relevant search keywords to ensure this feature request hadn't been filed or answered before.
3424
3525
- type: textarea
3626
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)