diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 3da8f1b..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -# IMPORTANT - -# Read and follow these instructions carefully. Help us help you. - -### Are you up-to-date? - -Upgrade to the latest version and confirm the issue/bug is still there. - -`$ pip install yfinance --upgrade --no-cache-dir` - -Confirm by running: - -`import yfinance as yf ; print(yf.__version__)` - -and comparing against [PIP](https://pypi.org/project/yfinance/#history). - -### Does Yahoo actually have the data? - -Are you spelling symbol *exactly* same as Yahoo? - -Then visit `finance.yahoo.com` and confirm they have the data you want. Maybe your symbol was delisted, or your expectations of `yfinance` are wrong. - -### Are you spamming Yahoo? - -Yahoo Finance free service has rate-limiting depending on request type - roughly 60/minute for prices, 10/minute for info. Once limit hit, Yahoo can delay, block, or return bad data -> not a `yfinance` bug. - -### Still think it's a bug? - -**Delete these instructions** and replace with your bug report, providing the following as best you can: - -- Simple code that reproduces your problem, that we can copy-paste-run. -- Run code with [debug logging enabled](https://github.com/ranaroussi/yfinance#logging) and post the full output. -- If you think `yfinance` returning bad data, give us proof. -- `yfinance` version and Python version. -- Operating system type. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..f0a4232 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,88 @@ +name: Bug report +description: Report a bug in our project +labels: ["bug"] + +body: + - type: markdown + attributes: + value: | + # IMPORTANT - Read and follow these instructions carefully. Help us help you. + + ### Does issue already exist? + + Use the search tool. Don't annoy everyone by duplicating existing Issues. + + ### Are you up-to-date? + + Upgrade to the latest version and confirm the issue/bug is still there. + + `$ pip install yfinance --upgrade --no-cache-dir` + + Confirm by running: + + `import yfinance as yf ; print(yf.__version__)` + + and comparing against [PIP](https://pypi.org/project/yfinance/#history). + + ### Does Yahoo actually have the data? + + Are you spelling symbol *exactly* same as Yahoo? + + Then visit `finance.yahoo.com` and confirm they have the data you want. Maybe your symbol was delisted, or your expectations of `yfinance` are wrong. + + ### Are you spamming Yahoo? + + Yahoo Finance free service has rate-limiting https://github.com/ranaroussi/yfinance/discussions/1513. Once limit hit, Yahoo can delay, block, or return bad data -> not a `yfinance` bug. + + - type: markdown + attributes: + value: | + --- + ## Still think it's a bug? + + Provide the following as best you can: + + - type: textarea + id: code + attributes: + label: "Simple code that reproduces your problem" + description: "Provide a snippet of code that we can copy-paste-run. Wrap code in Python Markdown code blocks for proper formatting (```python ... ```)." + validations: + required: true + + - type: textarea + id: debug-log + attributes: + label: "Debug log" + description: "Run code with debug logging enabled and post the full output. Instructions: https://github.com/ranaroussi/yfinance/tree/main#logging" + validations: + required: true + + - type: textarea + id: bad-data-proof + attributes: + label: "Bad data proof" + description: "If you think `yfinance` returning bad data, provide your proof here." + validations: + required: false + + - type: input + id: version-yfinance + attributes: + label: "`yfinance` version" + validations: + required: true + + - type: input + id: version-python + attributes: + label: "Python version" + validations: + required: false + + - type: input + id: os + attributes: + label: "Operating system" + validations: + required: false