Skip to content

Commit 5bcaee0

Browse files
kernckernc
committed
MNT: Add .github/ISSUE_TEMPLATE
1 parent 65d1437 commit 5bcaee0

File tree

5 files changed

+149
-11
lines changed

5 files changed

+149
-11
lines changed

‎.github/ISSUE_TEMPLATE/1-bug.yml

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: Bug report
2+
description: File a new bug report. Please use the search
3+
title: "Short title loaded with keywords"
4+
body:
5+
- type: markdown
6+
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.
10+
11+
- type: checkboxes
12+
attributes:
13+
label: Contributing guidelines
14+
description: |
15+
I have read and will follow
16+
[Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md).
17+
options:
18+
- label: I agree to follow this project's Contributing Guidelines
19+
required: true
20+
21+
- type: textarea
22+
id: expected
23+
validations:
24+
required: true
25+
attributes:
26+
label: Expected behavior
27+
description: You run the code below and expect what to happen?
28+
placeholder: When I run this code ... the program should ...
29+
30+
- type: textarea
31+
id: code
32+
validations:
33+
required: false
34+
attributes:
35+
label: Code sample
36+
description: Code snippet that clearly reproduces the issue
37+
render: python
38+
placeholder: |
39+
from backtesting import Backtest, Strategy
40+
from backtesting.test import GOOG
41+
42+
class Example(Strategy):
43+
...
44+
45+
bt = Backtest(GOOG, Example)
46+
...
47+
48+
- type: textarea
49+
id: actual
50+
validations:
51+
required: true
52+
attributes:
53+
label: Actual behavior
54+
description: What happened unexpectedly when you ran the code above?
55+
placeholder: When I ran the code above ... the program did ...
56+
57+
- type: textarea
58+
id: steps
59+
validations:
60+
required: false
61+
attributes:
62+
label: Additional info, steps to reproduce, screenshots
63+
description: |
64+
Attach any additional info you think might be helpful and
65+
result in quicker resolution of your bug.
66+
placeholder: |
67+
1. Do ...
68+
2. ...
69+
3. Boom.
70+
71+
- type: textarea
72+
id: versions
73+
validations:
74+
required: false
75+
attributes:
76+
label: Software versions
77+
description: |
78+
Versions of the relevant software / packages.
79+
value: |
80+
<!-- From `backtesting.__version__`. If git, use commit hash -->
81+
- Backtesting version: 0.?.?
82+
- `bokeh.__version__`:
83+
- OS:

‎.github/ISSUE_TEMPLATE/2-enh.yml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Enhancement proposal
2+
description: Describe the enhancement you'd like to see
3+
title: "Short title loaded with keywords"
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to give feedback on this software!
10+
11+
- type: checkboxes
12+
attributes:
13+
label: Contributing guidelines
14+
description: |
15+
I have read and will follow
16+
[Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md).
17+
options:
18+
- label: I agree to follow this project's Contributing Guidelines
19+
required: true
20+
21+
- type: textarea
22+
id: expected
23+
validations:
24+
required: true
25+
attributes:
26+
label: Enhancement description
27+
description: What would you want to see in the software that doesn't appear to be presently included?
28+
placeholder: I absolutely love your software, but I'm missing a way to ...
29+
30+
- type: textarea
31+
id: code
32+
validations:
33+
required: false
34+
attributes:
35+
label: Code sample
36+
description: Code snippet relevant to the new feature
37+
render: python
38+
39+
- type: textarea
40+
id: steps
41+
validations:
42+
required: false
43+
attributes:
44+
label: Additional info, images
45+
description: |
46+
Extra information you think might be helpful or interesting.

‎.github/ISSUE_TEMPLATE/config.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Reference documentation
4+
url: https://kernc.github.io/backtesting.py/doc/backtesting/
5+
about: Please confirm you've checked here first.
6+
- name: FAQ
7+
url: https://github.com/kernc/backtesting.py/issues?q=label%3Aquestion%20
8+
about: Frequently asked questions. Use search with potential keywords.
9+
- name: Discussion forum
10+
url: https://github.com/kernc/backtesting.py/discussions
11+
about: Other discussions. Make sure you've seen this too.

‎.github/issue_template.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
### Expected Behavior
22

3+
...
34

45
### Actual Behavior
56

6-
<!-- In case of a bug, attach full exception traceback. Please
7-
wrap verbatim code/output in Markdown fenced code blocks:
8-
https://bit.ly/3nEvlHP -->
7+
<!--
8+
In case of a bug, attach full exception traceback.
9+
Please wrap verbatim code/output in Markdown fenced code blocks.
10+
-->
911

1012

1113
### Steps to Reproduce
@@ -25,8 +27,4 @@ python code goes here
2527

2628
### Additional info
2729

28-
<!-- screenshots, code snippets, ... -->
29-
30-
- Backtesting version: 0.?.? <!-- From backtesting.__version__ -->
31-
- `bokeh.__version__`:
32-
- OS:
30+
<!-- screenshots, code snippets, versions ... -->

‎CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ have been fixed already.
99

1010
To have your issue dealt with promptly, it's best to construct a
1111
[minimal working example] that exposes the issue in a clear and
12-
reproducible manner. Make sure to understand
13-
[how to report bugs effectively][bugs] and how to
12+
reproducible manner. Review [how to report bugs effectively][bugs]
13+
and, particularly, how to
1414
[craft useful bug reports][bugs2] in Python.
1515

1616
In case of bugs, please submit full tracebacks
@@ -23,7 +23,7 @@ Many thanks from the maintainers!
2323
[minimal working example]: https://en.wikipedia.org/wiki/Minimal_working_example
2424
[bugs]: https://www.chiark.greenend.org.uk/~sgtatham/bugs.html
2525
[bugs2]: https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports
26-
[fenced code blocks]: https://www.markdownguide.org/extended-syntax/#fenced-code-blocks
26+
[fenced code blocks]: https://www.markdownguide.org/extended-syntax/#syntax-highlighting
2727

2828

2929
Installation

0 commit comments

Comments
 (0)