mirror of
https://github.com/kernc/backtesting.py.git
synced 2024-01-28 15:29:30 +03:00
DOC: Revise contributing/readme
This commit is contained in:
2
.github/issue_template.md
vendored
2
.github/issue_template.md
vendored
@@ -28,3 +28,5 @@ python code goes here
|
||||
<!-- screenshots, code snippets, ... -->
|
||||
|
||||
- Backtesting version: 0.?.? <!-- From backtesting.__version__ -->
|
||||
- `bokeh.__version__`:
|
||||
- OS:
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
|
||||
@@ -103,6 +103,14 @@ Features
|
||||

|
||||
|
||||
|
||||
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
|
||||
|
||||
2
setup.py
2
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',
|
||||
|
||||
Reference in New Issue
Block a user