mirror of
https://github.com/nathom/streamrip.git
synced 2025-05-25 04:24:49 -04:00
Issue templates update
This commit is contained in:
parent
19a77834a0
commit
6199a0413c
4 changed files with 50 additions and 112 deletions
23
.github/Feature_request.md
vendored
23
.github/Feature_request.md
vendored
|
@ -1,23 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F680 Feature Request"
|
|
||||||
about: "I have a suggestion (and may want to implement it \U0001F642)!"
|
|
||||||
title: ''
|
|
||||||
labels: 'i: enhancement, i: needs triage'
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Feature Request
|
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
|
||||||
A clear and concise description of what the problem is. Ex. I have an issue when [...]
|
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
|
||||||
A clear and concise description of what you want to happen. Add any considered drawbacks.
|
|
||||||
|
|
||||||
**Describe alternatives you've considered**
|
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
|
||||||
|
|
||||||
**Teachability, Documentation, Adoption, Migration Strategy**
|
|
||||||
If you can, explain how users will be able to use this and possibly write out a version the docs.
|
|
||||||
Maybe a screenshot or design?
|
|
52
.github/ISSUE_TEMPLATE.md
vendored
52
.github/ISSUE_TEMPLATE.md
vendored
|
@ -1,52 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F41B Bug Report"
|
|
||||||
about: "If something isn't working as expected \U0001F914."
|
|
||||||
title: ''
|
|
||||||
labels: 'i: bug'
|
|
||||||
assignees: 'nathom'
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Bug Report
|
|
||||||
|
|
||||||
**Current Behavior**
|
|
||||||
A clear and concise description of the behavior.
|
|
||||||
|
|
||||||
**Command used:**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
type the command that caused the bug here
|
|
||||||
```
|
|
||||||
|
|
||||||
**Expected behavior/code**
|
|
||||||
A clear and concise description of what you expected to happen (or code).
|
|
||||||
|
|
||||||
**`streamrip Configuration File (find using `rip config -o`):**
|
|
||||||
|
|
||||||
<!-- If the command isn't working, you can find the file at one of the following paths:-->
|
|
||||||
|
|
||||||
<!-- macOS: ~/Library/Application Support/streamrip -->
|
|
||||||
|
|
||||||
<!-- Linux: ~/.config/streamrip or ~/.streamrip -->
|
|
||||||
|
|
||||||
<!-- Windows: \Users\<username>\AppData\Local\Foo Bar -->
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Paste the contents of config.yaml here
|
|
||||||
# REMOVE YOUR CREDENTIALS
|
|
||||||
your:
|
|
||||||
- config
|
|
||||||
- file
|
|
||||||
```
|
|
||||||
|
|
||||||
**Environment**
|
|
||||||
|
|
||||||
- `streamrip` version(s): [e.g. v0.5.2]
|
|
||||||
- Python version: [e.g. 3.8]
|
|
||||||
- OS: [e.g. OSX 10.13.4, Windows 10]
|
|
||||||
|
|
||||||
**Possible Solution**
|
|
||||||
<!--- Only if you have suggestions on a fix for the bug -->
|
|
||||||
|
|
||||||
**Additional context/Screenshots**
|
|
||||||
Add any other context about the problem here. If applicable, add screenshots to help explain.
|
|
68
.github/ISSUE_TEMPLATE/bug_report.md
vendored
68
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -1,38 +1,52 @@
|
||||||
---
|
---
|
||||||
name: Bug report
|
name: "\U0001F41B Bug Report"
|
||||||
about: Create a report to help us improve
|
about: "If something isn't working as expected \U0001F914."
|
||||||
title: ''
|
title: ''
|
||||||
labels: ''
|
labels: 'i: bug'
|
||||||
assignees: ''
|
assignees: 'nathom'
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
## Bug Report
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**To Reproduce**
|
**Current Behavior**
|
||||||
Steps to reproduce the behavior:
|
A clear and concise description of the behavior.
|
||||||
1. Go to '...'
|
|
||||||
2. Click on '....'
|
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
**Command used:**
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Screenshots**
|
```bash
|
||||||
If applicable, add screenshots to help explain your problem.
|
type the command that caused the bug here
|
||||||
|
```
|
||||||
|
|
||||||
**Desktop (please complete the following information):**
|
**Expected behavior/code**
|
||||||
- OS: [e.g. iOS]
|
A clear and concise description of what you expected to happen (or code).
|
||||||
- Browser [e.g. chrome, safari]
|
|
||||||
- Version [e.g. 22]
|
|
||||||
|
|
||||||
**Smartphone (please complete the following information):**
|
**`streamrip Configuration File (find using `rip config -o`):**
|
||||||
- Device: [e.g. iPhone6]
|
|
||||||
- OS: [e.g. iOS8.1]
|
|
||||||
- Browser [e.g. stock browser, safari]
|
|
||||||
- Version [e.g. 22]
|
|
||||||
|
|
||||||
**Additional context**
|
<!-- If the command isn't working, you can find the file at one of the following paths:-->
|
||||||
Add any other context about the problem here.
|
|
||||||
|
<!-- macOS: ~/Library/Application Support/streamrip -->
|
||||||
|
|
||||||
|
<!-- Linux: ~/.config/streamrip or ~/.streamrip -->
|
||||||
|
|
||||||
|
<!-- Windows: \Users\<username>\AppData\Local\Foo Bar -->
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Paste the contents of config.yaml here
|
||||||
|
# REMOVE YOUR CREDENTIALS
|
||||||
|
your:
|
||||||
|
- config
|
||||||
|
- file
|
||||||
|
```
|
||||||
|
|
||||||
|
**Environment**
|
||||||
|
|
||||||
|
- `streamrip` version(s): [e.g. v0.5.2]
|
||||||
|
- Python version: [e.g. 3.8]
|
||||||
|
- OS: [e.g. OSX 10.13.4, Windows 10]
|
||||||
|
|
||||||
|
**Possible Solution**
|
||||||
|
<!--- Only if you have suggestions on a fix for the bug -->
|
||||||
|
|
||||||
|
**Additional context/Screenshots**
|
||||||
|
Add any other context about the problem here. If applicable, add screenshots to help explain.
|
19
.github/ISSUE_TEMPLATE/feature_request.md
vendored
19
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -1,20 +1,19 @@
|
||||||
---
|
---
|
||||||
name: Feature request
|
name: "\U0001F680 Feature Request"
|
||||||
about: Suggest an idea for this project
|
about: "I have a suggestion (and may want to implement it \U0001F642)!"
|
||||||
title: ''
|
title: ''
|
||||||
labels: ''
|
labels: 'i: enhancement'
|
||||||
assignees: ''
|
assignees: 'nathom'
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Feature Request
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
**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 [...]
|
A clear and concise description of what the problem is. Ex. I have an issue when [...]
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
**Describe the solution you'd like**
|
||||||
A clear and concise description of what you want to happen.
|
A clear and concise description of what you want to happen. Add any considered drawbacks.
|
||||||
|
|
||||||
**Describe alternatives you've considered**
|
**Describe alternatives you've considered**
|
||||||
A clear and concise description of any alternative solutions or features 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.
|
|
Loading…
Add table
Add a link
Reference in a new issue