diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml new file mode 100644 index 00000000..7f311e4f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug.yml @@ -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: | + + - Backtesting version: 0.?.? + - `bokeh.__version__`: + - OS: diff --git a/.github/ISSUE_TEMPLATE/2-enh.yml b/.github/ISSUE_TEMPLATE/2-enh.yml new file mode 100644 index 00000000..8db618d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-enh.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..d9d8b9a3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/issue_template.md b/.github/issue_template.md index ee5bac21..942fe85d 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,11 +1,13 @@ ### Expected Behavior +... ### Actual Behavior - + ### Steps to Reproduce @@ -25,8 +27,4 @@ python code goes here ### Additional info - - -- Backtesting version: 0.?.? -- `bokeh.__version__`: -- OS: + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 90418552..77c4967f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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