diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 8e8b88d6..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - -⚠ REPORTS WITHOUT THIS INFORMATION WILL NOT BE ACCEPTED! PLEASE RESPECT OTHER'S TIME! ⚠ - -Please make a proper bug report. The template is put here for a reason, edit it according to your situation. - -It's not cool to just throw lines of log without any context and comments. You have to be specific if you want people to help you. - -👆 - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Desktop (please complete the following information):** - - OS: [e.g. Windows] - - Python version [e.g. 3.x] - - Miner version - - Other relevant software versions - -**Log** -How to provide a DEBUG log: -1. Set -```py -logger_settings=LoggerSettings( - save=True, - console_level=logging.INFO, - file_level=logging.DEBUG, - less=True, -``` -in your runner script (`run.py`). - -2. Start the miner, wait for the error, then stop the miner and post the contents of the log file (`logs\username.log`) to https://gist.github.com/ and post a link here. - -3. Create another gist with your console output, just in case. Paste a link here as well. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..39e5ce5c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,78 @@ +name: Bug report +description: Create a report to help us improve +labels: bug + +body: + - type: textarea + id: description + attributes: + label: Describe the bug + description: | + A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: What do you expect to happen? + validations: + required: true + - type: input + id: operating-system + attributes: + label: Operating system + placeholder: Windows 10 + validations: + required: true + - type: input + id: python-version + attributes: + label: Python version + placeholder: "3.10" + validations: + required: true + - type: input + id: miner-version + attributes: + label: Miner version + validations: + required: true + - type: textarea + id: other-environment-info + attributes: + label: Other relevant software versions + - type: textarea + id: logs + attributes: + label: Logs + description: | + How to provide a DEBUG log: + 1. Set this in your runner script (`run.py`): + ```py + logger_settings=LoggerSettings( + save=True, + console_level=logging.INFO, + file_level=logging.DEBUG, + less=True, + ``` + 2. Start the miner, wait for the error, then stop the miner and post the contents of the log file (`logs\username.log`) to https://gist.github.com/ and post a link here. + 3. Create another gist with your console output, just in case. Paste a link here as well. + validations: + required: true + - type: textarea + id: other-info + attributes: + label: Additional context + description: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ac2e8b47 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 11fc491e..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..e71aa868 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,31 @@ +name: Feature request +description: Suggest an idea for this project +labels: enhancement + +body: + - type: textarea + id: description + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when [...] + - type: textarea + id: solution + attributes: + label: Proposed solution + description: | + Suggest your feature here. What benefit would it bring? + + Do you have any ideas on how to implement it? + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives you've considered + description: Suggest any alternative solutions or features you've considered. + - type: textarea + id: other-info + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here.