Skip to content

Commit 5f1ba8c

Browse files
opusforlife2TobiGr
andauthored
Add issue templates (#1204)
* Create bug report template * Create feature request template * Create config.yml --------- Co-authored-by: TobiGr <[email protected]>
1 parent 176da72 commit 5f1ba8c

File tree

3 files changed

+151
-0
lines changed

3 files changed

+151
-0
lines changed
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: Bug report
2+
description: Create a bug report to help us improve
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for helping to make the NewPipe Extractor better by reporting a bug. :hugs:
9+
10+
Please fill in as much information as possible about your bug so that we don't have to play "information ping-pong" and can help you immediately.
11+
12+
- type: checkboxes
13+
id: checklist
14+
attributes:
15+
label: "Checklist"
16+
options:
17+
- label: "I am able to reproduce the bug with the latest version given here: [CLICK THIS LINK](https://github.com/TeamNewPipe/NewPipeExtractor/releases/latest)."
18+
required: true
19+
- label: "I am aware that this issue is being opened for the NewPipe Extractor, NOT the [app](https://github.com/TeamNewPipe/NewPipe), and my bug report will be dismissed otherwise."
20+
required: true
21+
- label: "I made sure that there are *no existing issues* - [open](https://github.com/TeamNewPipe/NewPipeExtractor/issues) or [closed](https://github.com/TeamNewPipe/NewPipeExtractor/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
22+
required: true
23+
- label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
24+
required: true
25+
- label: "This issue contains only one bug."
26+
required: true
27+
- label: "I have read and understood the [contribution guidelines](https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md)."
28+
required: true
29+
30+
- type: input
31+
id: extractor-version
32+
attributes:
33+
label: Affected version
34+
description: "In which NewPipe Extractor version did you encounter the bug?"
35+
placeholder: "x.xx.x"
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: steps-to-reproduce
41+
attributes:
42+
label: Steps to reproduce the bug
43+
description: |
44+
What did you do for the bug to show up?
45+
46+
If you can't cause the bug to show up again reliably (and hence don't have a proper set of steps to give us), please still try to give as many details as possible on how you think you encountered the bug.
47+
placeholder: |
48+
1. Init NewPipe with 'NewPipe.init(...)'
49+
2. Create a StreamExtractor for xyz: 'StreamExtractor e = YouTube.getStreamExtractor(xyz.com)'
50+
3. Get the description 'e.getDescription()'
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: expected-behavior
56+
attributes:
57+
label: Expected behavior
58+
description: |
59+
Tell us what you expect to happen.
60+
61+
- type: textarea
62+
id: actual-behavior
63+
attributes:
64+
label: Actual behavior
65+
description: |
66+
Tell us what happens with the steps given above.
67+
68+
- type: textarea
69+
id: screen-media
70+
attributes:
71+
label: Screenshots/Screen recordings
72+
description: |
73+
A picture or video is worth a thousand words.
74+
75+
If applicable, add screenshots or a screen recording to help explain your problem.
76+
GitHub supports uploading them directly in the text box.
77+
If your file is too big for Github to accept, try to compress it (ZIP-file) or feel free to paste a link to an image/video hoster here instead.
78+
79+
- type: textarea
80+
id: logs
81+
attributes:
82+
label: Logs
83+
description: |
84+
If your bug includes a log you think we need to see, paste it here.
85+
86+
- type: textarea
87+
id: additional-information
88+
attributes:
89+
label: Additional information
90+
description: |
91+
Any other information you'd like to include, for instance that
92+
* your cat disabled your network connection
93+
* ...

.github/ISSUE_TEMPLATES/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Matrix
4+
url: https://matrix.to/#/#newpipe:matrix.newpipe-ev.de
5+
about: Chat with us via Matrix for quick Q/A
6+
- name: 💬 IRC
7+
url: https://web.libera.chat/#newpipe
8+
about: Chat with us via IRC for quick Q/A
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: [enhancement]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for helping to make the NewPipe Extractor better by suggesting a feature. :hugs:
9+
10+
Your ideas are highly welcome! The Extractor is made for you, the downstream developers, after all.
11+
12+
- type: checkboxes
13+
id: checklist
14+
attributes:
15+
label: "Checklist"
16+
options:
17+
- label: "I am aware that this issue is being opened for the NewPipe Extractor, NOT the [app](https://github.com/TeamNewPipe/NewPipe), and my feature request will be dismissed otherwise."
18+
required: true
19+
- label: "I made sure that there are *no existing issues* - [open](https://github.com/TeamNewPipe/NewPipeExtractor/issues) or [closed](https://github.com/TeamNewPipe/NewPipeExtractor/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
20+
required: true
21+
- label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
22+
required: true
23+
- label: "This issue contains only one feature request."
24+
required: true
25+
- label: "I have read and understood the [contribution guidelines](https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md)."
26+
required: true
27+
28+
- type: textarea
29+
id: feature-description
30+
attributes:
31+
label: Feature description
32+
description: |
33+
Explain how you want the Extractor's behavior to change to suit your needs.
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: why-is-the-feature-requested
39+
attributes:
40+
label: Why do you want this feature?
41+
description: |
42+
Describe any problem or limitation you come across while using the Extractor which would be solved by this feature.
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: additional-information
48+
attributes:
49+
label: Additional information
50+
description: Any other information you'd like to include, for instance sketches, mockups, pictures of cats, etc.

0 commit comments

Comments
 (0)