mirror of
https://github.com/microsoft/qlib.git
synced 2026-07-16 17:12:20 +08:00
Add PEP8 style check and add bug report issue template
This commit is contained in:
38
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
38
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
---
|
||||||
|
name: "\U0001F41B Bug Report"
|
||||||
|
about: Submit a bug report to help us improve Qlib
|
||||||
|
labels: bug
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🐛 Bug Description
|
||||||
|
|
||||||
|
<!-- A clear and concise description of what the bug is. -->
|
||||||
|
|
||||||
|
## To Reproduce
|
||||||
|
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
|
||||||
|
1.
|
||||||
|
1.
|
||||||
|
1.
|
||||||
|
|
||||||
|
|
||||||
|
## Expected Behavior
|
||||||
|
|
||||||
|
<!-- A clear and concise description of what you expected to happen. -->
|
||||||
|
|
||||||
|
## Screenshot
|
||||||
|
|
||||||
|
<!-- A screenshot of the error message or anything shouldn't appear-->
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
|
||||||
|
- Qlib version:
|
||||||
|
- Python version:
|
||||||
|
- OS (`Windows`, `Linux`, `MacOS`):
|
||||||
|
- Commit number:
|
||||||
|
|
||||||
|
## Additional Notes
|
||||||
|
|
||||||
|
<!-- Add any other information about the problem here. -->
|
||||||
14
.github/workflows/test.yml
vendored
14
.github/workflows/test.yml
vendored
@@ -33,7 +33,7 @@ jobs:
|
|||||||
- name: Install test dependencies
|
- name: Install test dependencies
|
||||||
run: |
|
run: |
|
||||||
python -m pip install --upgrade pip
|
python -m pip install --upgrade pip
|
||||||
pip install flake8 pytest
|
pip install flake8 pytest pep8
|
||||||
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
|
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
|
||||||
|
|
||||||
- name: Lint with flake8
|
- name: Lint with flake8
|
||||||
@@ -43,6 +43,11 @@ jobs:
|
|||||||
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
|
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
|
||||||
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
|
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
|
||||||
|
|
||||||
|
- name: Check PEP8 python code style
|
||||||
|
run: |
|
||||||
|
find . -name \*.py -exec pep8 {} +
|
||||||
|
|
||||||
|
|
||||||
- name: Test with pytest
|
- name: Test with pytest
|
||||||
run: |
|
run: |
|
||||||
pytest ../qlib
|
pytest ../qlib
|
||||||
@@ -57,9 +62,4 @@ jobs:
|
|||||||
python scripts/get_data.py qlib_data_cn --target_dir ~/.qlib/qlib_data/cn_data
|
python scripts/get_data.py qlib_data_cn --target_dir ~/.qlib/qlib_data/cn_data
|
||||||
cd examples
|
cd examples
|
||||||
estimator -c estimator/estimator_config.yaml
|
estimator -c estimator/estimator_config.yaml
|
||||||
jupyter nbconvert --execute estimator/analyze_from_estimator.ipynb
|
jupyter nbconvert --execute estimator/analyze_from_estimator.ipynb
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -31,3 +31,5 @@ mlruns/
|
|||||||
|
|
||||||
tags
|
tags
|
||||||
|
|
||||||
|
.pytest_cache/
|
||||||
|
.vscode/
|
||||||
|
|||||||
Reference in New Issue
Block a user