Skip to content

Commit b8285d4

Browse files
committed
DOC: Revise contributing/readme
1 parent e2df305 commit b8285d4

File tree

4 files changed

+21
-3
lines changed

4 files changed

+21
-3
lines changed

.github/issue_template.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,5 @@ python code goes here
2828
<!-- screenshots, code snippets, ... -->
2929

3030
- Backtesting version: 0.?.? <!-- From backtesting.__version__ -->
31+
- `bokeh.__version__`:
32+
- OS:

CONTRIBUTING.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,19 @@ have been fixed already.
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
1212
reproducible manner. Make sure to understand
13-
[how to report bugs effectively][bugs].
13+
[how to report bugs effectively][bugs] and how to
14+
[craft useful bug reports][bugs2] in Python.
1415

15-
Show verbatim code in [fenced code blocks], and use the
16-
preview function!
16+
In case of bugs, please submit full tracebacks
17+
18+
Wrap verbatim example code/traceback in [fenced code blocks],
19+
and use the preview function!
20+
21+
Many thanks from the maintainers!
1722

1823
[minimal working example]: https://en.wikipedia.org/wiki/Minimal_working_example
1924
[bugs]: https://www.chiark.greenend.org.uk/~sgtatham/bugs.html
25+
[bugs2]: https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports
2026
[fenced code blocks]: https://www.markdownguide.org/extended-syntax/#fenced-code-blocks
2127

2228

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,14 @@ Features
103103
![xkcd.com/1570](https://imgs.xkcd.com/comics/engineer_syllogism.png)
104104

105105

106+
Bugs
107+
----
108+
Before reporting bugs or posting to the
109+
[discussion board](https://github.com/kernc/backtesting.py/discussions),
110+
please read [contributing guidelines](CONTRIBUTING.md), particularly the section
111+
about crafting useful bug reports and ```` ``` ````-fencing your code. We thank you!
112+
113+
106114
Alternatives
107115
------------
108116
See [alternatives.md] for a list of alternative Python

setup.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
classifiers=[
6262
'Intended Audience :: Financial and Insurance Industry',
6363
'Intended Audience :: Science/Research',
64+
'Framework :: Jupyter',
6465
'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)',
6566
'Operating System :: OS Independent',
6667
'Programming Language :: Python :: 3 :: Only',
@@ -120,6 +121,7 @@
120121
'quantitative',
121122
'rsi',
122123
'silver',
124+
'simulation',
123125
'stocks',
124126
'strategy',
125127
'ticker',

0 commit comments

Comments
 (0)