MNT: Update issue templates

kernc · kernc · commit 70abc06279cf · 2025-02-17T02:27:06.000+01:00
* Don't submit perfunctory form fields.
* Don't break on Markdown newlines.
diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml
@@ -4,33 +4,31 @@ title: "Short title loaded with keywords"
 body:
   - type: markdown
     attributes:
-      value: |
+      value: >+
         Thanks for putting in the effort to submit this bug report! Note, the
         best bug reports are accompanied with fixing patches / pull-requests. 🙏
 
-  - type: checkboxes
+  - type: markdown
     attributes:
-      label: Contributing guidelines
-      description: |
-        Please kindly follow this project's
-        [Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md).
-        The guidelines contain short technical notes on how to best contribute to this project.
-      options:
-        - label: |
-            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.
-          required: true
+      value: >+
+        **Contributing guidelines** $\color{red}{*}$
 
-  - type: checkboxes
+        - [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.
+
+  - type: markdown
     attributes:
-      label: Own due diligence
-      options:
-        - label: |
-            I verify my due dilligence—I have went through the **tutorials** and the **API docs** and
-            have used the **search** on **Issues** and GitHub **Disucussions**, as well all Google,
-            with all the relevant search keywords.
-          required: true
+      value: >+
+        **Own due diligence** $\color{red}{*}$
+
+        - [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.
 
   - type: textarea
     id: expected
@@ -39,7 +37,7 @@ body:
     attributes:
       label: Expected behavior
       description: You run the code below and expect what to happen?
-      placeholder: When I run this code ... the program should ...
+      placeholder: When I run the code below ... the program should ...
 
   - type: textarea
     id: code
@@ -53,7 +51,7 @@ body:
         from backtesting import Backtest, Strategy
         from backtesting.test import GOOG
 
-        class Example(Strategy):
+        class MinimalExample(Strategy):
             ...
 
         bt = Backtest(GOOG, Example)
diff --git a/.github/ISSUE_TEMPLATE/2-enh.yml b/.github/ISSUE_TEMPLATE/2-enh.yml
@@ -5,32 +5,30 @@ labels: ["enhancement"]
 body:
   - type: markdown
     attributes:
-      value: |
+      value: >+
         Thanks for taking the time to give feedback on this software!
 
-  - type: checkboxes
+  - type: markdown
     attributes:
-      label: Contributing guidelines
-      description: |
-        Please kindly follow this project's
-        [Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md).
-        The guidelines contain short technical notes on how to best contribute to this project.
-      options:
-        - label: |
-            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.
-          required: true
+      value: >+
+        **Contributing guidelines** $\color{red}{*}$
+
+        - [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.
 
-  - type: checkboxes
+  - type: markdown
     attributes:
-      label: Own due diligence
-      options:
-        - label: |
-            I verify my due dilligence—I have went through the **tutorials** and the **API docs** and
-            have used the **search** on **Issues** and GitHub **Disucussions**, as well all Google,
-            with all the relevant search keywords.
-          required: true
+      value: >+
+        **Own due diligence** $\color{red}{*}$
+
+        - [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.
 
   - type: textarea
     id: expected
diff --git a/backtesting/_plotting.py b/backtesting/_plotting.py
@@ -728,7 +728,7 @@ def plot_heatmaps(heatmap: pd.Series, agg: Union[Callable, str], ncols: int,
     param_combinations = combinations(heatmap.index.names, 2)
     dfs = [heatmap.groupby(list(dims)).agg(agg).to_frame(name='_Value')
            for dims in param_combinations]
-    figs = []
+    figs: list[_figure] = []
     cmap = LinearColorMapper(palette='Viridis256',
                              low=min(df.min().min() for df in dfs),
                              high=max(df.max().max() for df in dfs),
