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.
9
9
10
10
To have your issue dealt with promptly, it's best to construct a
11
11
[ 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!
13
17
14
18
[ 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
15
21
16
22
17
23
Installation
@@ -32,11 +38,12 @@ Please write reasonable unit tests for any new / changed functionality.
32
38
See _ backtesting/test_ directory for existing tests.
33
39
Before submitting a PR, ensure the tests pass:
34
40
35
- python setup.py test
41
+ python -m backtesting. test
36
42
37
43
Also ensure that idiomatic code style is respected by running:
38
44
39
45
flake8
46
+ mypy backtesting
40
47
41
48
42
49
Documentation
@@ -49,7 +56,10 @@ is generated from [pdoc]-compatible docstrings in code.
49
56
50
57
Pull requests
51
58
-------------
59
+ A general recommended reading:
60
+ [ How to make your code reviewer fall in love with you] [ code-review ] .
52
61
Please use explicit commit messages. See [ NumPy's development workflow]
53
62
for inspiration.
54
63
64
+ [ code-review ] : https://mtlynch.io/code-review-love/
55
65
[ 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