Skip to content

Commit

Permalink
MNT: Add .github/ISSUE_TEMPLATE
Browse files Browse the repository at this point in the history
  • Loading branch information
kernc committed Jan 28, 2025
1 parent 65d1437 commit d1d26f7
Show file tree
Hide file tree
Showing 5 changed files with 149 additions and 11 deletions.
83 changes: 83 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: Bug report
description: File a new bug report. Please use the search
title: "Short title loaded with keywords"
body:
- type: markdown
attributes:
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
attributes:
label: Contributing guidelines
description: |
I have read and will follow
[Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md).
options:
- label: I agree to follow this project's Contributing Guidelines
required: true

- type: textarea
id: expected
validations:
required: true
attributes:
label: Expected behavior
description: You run the code below and expect what to happen?
placeholder: When I run this code ... the program should ...

- type: textarea
id: code
validations:
required: false
attributes:
label: Code sample
description: Code snippet that clearly reproduces the issue
render: python
placeholder: |
from backtesting import Backtest, Strategy
from backtesting.test import GOOG
class Example(Strategy):
...
bt = Backtest(GOOG, Example)
...
- type: textarea
id: actual
validations:
required: true
attributes:
label: Actual behavior
description: What happened unexpectedly when you ran the code above?
placeholder: When I ran the code above ... the program did ...

- type: textarea
id: steps
validations:
required: false
attributes:
label: Additional info, steps to reproduce, full crash traceback, screenshots
description: |
Attach any additional info you think might be helpful and
result in quicker resolution of your bug.
placeholder: |
1. Do ...
2. ...
3. Boom.
- type: textarea
id: versions
validations:
required: false
attributes:
label: Software versions
description: |
Versions of the relevant software / packages.
value: |
<!-- From `backtesting.__version__`. If git, use commit hash -->
- Backtesting version: 0.?.?
- `bokeh.__version__`:
- OS:
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/2-enh.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Enhancement proposal
description: Describe the enhancement you'd like to see
title: "Short title loaded with keywords"
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to give feedback on this software!
- type: checkboxes
attributes:
label: Contributing guidelines
description: |
I have read and will follow
[Contributing Guidelines](https://github.com/kernc/backtesting.py/blob/master/CONTRIBUTING.md).
options:
- label: I agree to follow this project's Contributing Guidelines
required: true

- type: textarea
id: expected
validations:
required: true
attributes:
label: Enhancement description
description: What would you want to see in the software that doesn't appear to be presently included?
placeholder: I absolutely love your software, but I'm missing a way to ...

- type: textarea
id: code
validations:
required: false
attributes:
label: Code sample
description: Code snippet relevant to the new feature
render: python

- type: textarea
id: steps
validations:
required: false
attributes:
label: Additional info, images
description: |
Extra information you think might be helpful or interesting.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Reference documentation
url: https://kernc.github.io/backtesting.py/doc/backtesting/
about: Please confirm you've checked here first.
- name: FAQ
url: https://github.com/kernc/backtesting.py/issues?q=label%3Aquestion%20
about: Frequently asked questions. Use search with potential keywords.
- name: Discussion forum
url: https://github.com/kernc/backtesting.py/discussions
about: Other discussions. Make sure you've seen this too.
14 changes: 6 additions & 8 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
### Expected Behavior

...

### Actual Behavior

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


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

### Additional info

<!-- screenshots, code snippets, ... -->

- Backtesting version: 0.?.? <!-- From backtesting.__version__ -->
- `bokeh.__version__`:
- OS:
<!-- screenshots, code snippets, versions ... -->
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ have been fixed already.

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

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


Installation
Expand Down

0 comments on commit d1d26f7

Please sign in to comment.