File tree Expand file tree Collapse file tree 1 file changed +12
-2
lines changed Expand file tree Collapse file tree 1 file changed +12
-2
lines changed Original file line number Diff line number Diff line change @@ -9,9 +9,15 @@ have been fixed already.
99
1010To have your issue dealt with promptly, it's best to construct a
1111[ minimal working example] that exposes the issue in a clear and
12- reproducible manner.
12+ reproducible manner. Make sure to understand
13+ [ how to report bugs effectively] [ bugs ] .
14+
15+ Show verbatim code in [ fenced code blocks] , and use the
16+ preview function!
1317
1418[ minimal working example ] : https://en.wikipedia.org/wiki/Minimal_working_example
19+ [ bugs ] : https://www.chiark.greenend.org.uk/~sgtatham/bugs.html
20+ [ fenced code blocks ] : https://www.markdownguide.org/extended-syntax/#fenced-code-blocks
1521
1622
1723Installation
@@ -32,11 +38,12 @@ Please write reasonable unit tests for any new / changed functionality.
3238See _ backtesting/test_ directory for existing tests.
3339Before submitting a PR, ensure the tests pass:
3440
35- python setup.py test
41+ python -m backtesting. test
3642
3743Also ensure that idiomatic code style is respected by running:
3844
3945 flake8
46+ mypy backtesting
4047
4148
4249Documentation
@@ -49,7 +56,10 @@ is generated from [pdoc]-compatible docstrings in code.
4956
5057Pull requests
5158-------------
59+ A general recommended reading:
60+ [ How to make your code reviewer fall in love with you] [ code-review ] .
5261Please use explicit commit messages. See [ NumPy's development workflow]
5362for inspiration.
5463
64+ [ code-review ] : https://mtlynch.io/code-review-love/
5565[ NumPy's development workflow ] : https://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html
You can’t perform that action at this time.
0 commit comments