diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 0ba45684e..803459be1 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -28,7 +28,8 @@ Steps to reproduce the behavior: ## Environment -**Note**: One could run `python scripts/collect_info.py` under the `qlib` directory to get the following information. +**Note**: User could run `cd scripts && python collect_info.py all` under project directory to get system information +and paste them here directly. - Qlib version: - Python version: @@ -37,4 +38,4 @@ Steps to reproduce the behavior: ## Additional Notes - \ No newline at end of file + diff --git a/scripts/collect_info.py b/scripts/collect_info.py index ba53deb30..9950ac4cb 100644 --- a/scripts/collect_info.py +++ b/scripts/collect_info.py @@ -9,6 +9,11 @@ QLIB_PATH = Path(__file__).absolute().resolve().parent.parent class InfoCollector: + ''' + User could collect system info by following commands + `cd scripts && python collect_info.py all` + - NOTE: please avoid running this script in the project folder which contains `qlib` + ''' def sys(self): """collect system related info""" for method in ["system", "machine", "platform", "version"]: