1
0
mirror of https://github.com/microsoft/qlib.git synced 2026-07-05 20:11:08 +08:00

Update CI and add doc & question issue template

This commit is contained in:
Jactus
2020-09-28 09:42:42 +08:00
committed by you-n-g
parent 71cd874fe3
commit 6ae77b5524
5 changed files with 42 additions and 11 deletions

View File

@@ -0,0 +1,9 @@
---
name: "\U0001F4D6 Documentation"
about: Report an issue related to documentation
---
## 📖 Documentation
<!-- Please specify whether it's tutorial part or API reference part, and describe it.-->

View File

@@ -1,6 +1,7 @@
---
name: "\U0001F31FFeature Request"
about: Request for a new Qlib feature
labels: enhancement
---

10
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View File

@@ -0,0 +1,10 @@
---
name: "❓Questions & Help"
about: Have some questions? We can offer help.
labels: question
---
## ❓ Questions and Help
We sincerely suggest you to carefully read the [documentation](http://qlib.readthedocs.io/) of our library as well as the official [paper](https://arxiv.org/abs/2009.11189). After that, if you still feel puzzled, please describe the question clearly under this issue.

21
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,21 @@
<!--- Provide a general summary of your changes in the Title above -->
## Description
<!--- Describe your changes in detail -->
## Motivation and Context
<!--- Are there any related issues? If so, please put the link here. -->
<!--- Why is this change required? What problem does it solve? -->
## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, tests ran to see how -->
<!--- your change affects other areas of the code, etc. -->
## Screenshots (if appropriate):
## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Fix bugs
- [ ] Add new feature
- [ ] Update documentation

View File

@@ -33,7 +33,7 @@ jobs:
- name: Install test dependencies
run: |
python -m pip install --upgrade pip
pip install flake8 pytest pep8
pip install flake8 pytest
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Lint with flake8
@@ -43,19 +43,9 @@ jobs:
# 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
- name: Check PEP8 python code style
run: |
find . -name \*.py -exec pep8 {} +
- name: Test with pytest
run: |
pytest ../qlib
- name: Test documents
run: |
pip install sphinx sphinx_rtd_theme
make html
- name: Test data downloads and examples
run: |