diff --git a/.github/issue_template.md b/.github/issue_template.md index 88bb77f..ee5bac2 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -28,3 +28,5 @@ python code goes here - Backtesting version: 0.?.? +- `bokeh.__version__`: +- OS: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf8d05c..f28bf51 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,13 +10,19 @@ 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]. +[how to report bugs effectively][bugs] and how to +[craft useful bug reports][bugs2] in Python. -Show verbatim code in [fenced code blocks], and use the -preview function! +In case of bugs, please submit full tracebacks + +Wrap verbatim example code/traceback in [fenced code blocks], +and use the preview function! + +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 diff --git a/README.md b/README.md index f4fbe13..5363eab 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,14 @@ Features ![xkcd.com/1570](https://imgs.xkcd.com/comics/engineer_syllogism.png) +Bugs +---- +Before reporting bugs or posting to the +[discussion board](https://github.com/kernc/backtesting.py/discussions), +please read [contributing guidelines](CONTRIBUTING.md), particularly the section +about crafting useful bug reports and ```` ``` ````-fencing your code. We thank you! + + Alternatives ------------ See [alternatives.md] for a list of alternative Python diff --git a/setup.py b/setup.py index 8a0020f..056993c 100644 --- a/setup.py +++ b/setup.py @@ -61,6 +61,7 @@ if __name__ == '__main__': classifiers=[ 'Intended Audience :: Financial and Insurance Industry', 'Intended Audience :: Science/Research', + 'Framework :: Jupyter', 'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)', 'Operating System :: OS Independent', 'Programming Language :: Python :: 3 :: Only', @@ -120,6 +121,7 @@ if __name__ == '__main__': 'quantitative', 'rsi', 'silver', + 'simulation', 'stocks', 'strategy', 'ticker',