Skip to content

Commit

Permalink
Merge pull request #190 from reconman/master
Browse files Browse the repository at this point in the history
Replace bug reports and feature requests with Github forms
  • Loading branch information
rdavydov authored Mar 8, 2023
2 parents 3295c35 + 20397e7 commit 0004491
Show file tree
Hide file tree
Showing 5 changed files with 110 additions and 74 deletions.
54 changes: 0 additions & 54 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 0004491

Please sign in to comment.