Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitcc4ef27

Browse files
committed
Add CONTRIBUTING.md
1 parent22ad0eb commitcc4ef27

File tree

5 files changed

+66
-10
lines changed

5 files changed

+66
-10
lines changed

‎.flake8‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[flake8]
2+
max-line-length = 100
3+
exclude =
4+
.git,
5+
__pycache__,
6+
doc/examples

‎.travis.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ matrix:
2020
before_script:
2121
-pip install flake8 coverage
2222
script:
23-
-flake8 --max-line-length=120 --exclude doc/examples .
23+
-flake8
2424
-BOKEH_BROWSER=none catchsegv coverage run setup.py test
2525
after_success:
2626
-bash <(curl -s https://codecov.io/bash)

‎CONTRIBUTING.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
Contributing guidelines
2+
=======================
3+
4+
Issues
5+
------
6+
Before reporting an issue, see if a similar issue is already open.
7+
Also check if a similar issue was recently closed — your bug might
8+
have been fixed already.
9+
10+
To have your issue dealt with promptly, it's best to construct a
11+
[minimal working example] that exposes the issue in a clear and
12+
reproducible manner.
13+
14+
[minimal working example]:https://en.wikipedia.org/wiki/Minimal_working_example
15+
16+
17+
Installation
18+
------------
19+
To install a developmental version of the project,
20+
first[fork the project]. Then:
21+
22+
git clone git@github.com:YOUR_USERNAME/backtesting.py
23+
cd backtesting.py
24+
pip3 install -e .[doc,test,dev]
25+
26+
[fork the project]:https://help.github.com/articles/fork-a-repo/
27+
28+
29+
Testing
30+
-------
31+
Please write reasonable unit tests for any new / changed functionality.
32+
See_backtesting/test_ directory for existing tests.
33+
Before submitting a PR, ensure the tests pass:
34+
35+
python setup.py test
36+
37+
Also ensure that idiomatic code style is respected by running:
38+
39+
flake8
40+
41+
42+
Documentation
43+
-------------
44+
See_doc/README.md_. Besides Jupyter Notebook examples, all documentation
45+
is generated from[pdoc]-compatible docstrings in code.
46+
47+
[pdoc]:https://pdoc3.github.io/pdoc
48+
49+
50+
Pull requests
51+
-------------
52+
Please use explicit commit messages. See[NumPy's development workflow]
53+
for inspiration.
54+
55+
[NumPy's development workflow]:https://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html

‎README.md‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,3 @@ Backtest trading strategies with Python.
99
[**Project website**](https://kernc.github.io/backtesting.py/)
1010

1111
[Documentation](https://kernc.github.io/backtesting.py/doc/backtesting/)
12-
13-
Development
14-
-----------
15-
Fork the project. Then:
16-
17-
git clone git@github.com:YOUR_USERNAME/backtesting.py
18-
cd backtesting.py
19-
pip3 install -e .[doc]

‎setup.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,10 @@ def _discover_tests():
4747
],
4848
'test': [
4949
'seaborn',
50-
]
50+
],
51+
'dev': [
52+
'flake8',
53+
],
5154
},
5255
test_suite="setup._discover_tests",
5356
python_requires='>=3.4',

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp