summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorByteHamster <info@bytehamster.com>2020-07-09 19:30:33 +0200
committerByteHamster <info@bytehamster.com>2020-07-10 09:19:51 +0200
commita2ba76a320a5f76033b03db245b96fc439ca2315 (patch)
treef068dc0493b7a2223f5521c4c14c1a6c0e574b5f /.github
parent54db709fd6bfa5d28ed8ba5a76f5166739a824ea (diff)
downloadantennapod-a2ba76a320a5f76033b03db245b96fc439ca2315.zip
Updated issue templates
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md53
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml5
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md25
3 files changed, 35 insertions, 48 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index cb7c71b63..25697186a 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -4,46 +4,24 @@ about: Create a report to help us improve existing features
---
-<!--
-DELETE ME
+# Checklist
+<!-- Place an x in the boxes to tick them: [x] -->
-Use the search function to see if someone else has already submitted the same bug report.
+- [ ] I have used the search function to see if someone else has already submitted the same bug report.
+- [ ] I will describe the problem with as much detail as possible.
+- [ ] If the bug only to occurs with a certain podcast, I will include the URL of that podcast.
-Try to describe the problem with as much detail as possible.
-
-Some bugs may only occur on certain devices or versions of Android. Please add information about your device and the version of Android that is running on it (you can look these up under `Settings → About Phone`), as well as which version of AntennaPod you are using.
-
-If the bug only seems to occur with a certain podcast, please include the URL of that podcast.
-
-If possible, add instructions on how to reproduce the bug.
-
-If possible, add a logfile to your post. This is especially useful if the bug makes the application crash. AntennaPod has an `export logs` feature for this.
-
-Usually, you can take a screenshot of your smartphone by pressing *Power* + *Volume down* for a few seconds.
-
-You don't need to adhere to the template strictly. Feel free to leave out information you feel is not important or does not make sense.
-
-If you are experiencing a crash, including the stacktrace will likely get it fixed sooner.
--->
-
-<!-- READ THIS: The latest version may be different depending on your device. You can find the version in AntennaPod's settings. -->
-**App version**: x.y.z (state whether from Google Play/F-Droid/Custom built APK)
+# System info
+<!-- The following information is very important to fill out because some bugs may only occur on certain devices or versions of Android. -->
+**App version**: x.y.z (Where did you download the app?)
+<!-- The latest version may be different depending on your device. You can find the version in AntennaPod's settings. -->
**Android version**: 5.x (Please mention if you are using a custom rom!)
-
**Device model**:
-
-**Expected behaviour**:
-
-
-**Current behaviour**:
-
-
-**First occurred**: (e.g. about x days/weeks ago)
-
+# Bug description
**Steps to reproduce**:
1. This
@@ -51,11 +29,18 @@ If you are experiencing a crash, including the stacktrace will likely get it fix
3. Then this
4. Etc.
+**Expected behaviour**:
+<!-- After following the steps, what did you think AntennaPod would do? -->
-**Environment**: (Settings you have changed (e.g. Auto Download). "Unusual" devices you use (e.g. Bluetooth headphones). Did you select another media player?)
+**Current behaviour**:
+<!-- What did AntennaPod do instead? Screenshots might help. Usually, you can take a screenshot of your smartphone by pressing *Power* + *Volume down* for a few seconds. -->
+**First occurred**: (e.g. about x days/weeks ago)
+
+**Environment**: (Settings you have changed (e.g. Auto Download). "Unusual" devices you use (e.g. Bluetooth headphones). Did you select another media player?)
-**Stacktrace/Logcat**:
+**Stacktrace/Logcat**:
+<!-- If you are experiencing a crash, including the stacktrace will likely get it fixed sooner. AntennaPod has an `export logs` feature for this. -->
```
[if available]
```
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..04c65727a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+ - name: AntennaPod Forum
+ url: https://forum.antennapod.org/
+ about: Reduce developer's workload by asking other users.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 8719120cd..bb60476d6 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,28 +4,25 @@ about: Request a new feature
---
-<!--
-DELETE ME
+# Checklist
+<!-- Place an x in the boxes to tick them: [x] -->
-Make sure you are using the latest version of AntennaPod. Perhaps the feature you are looking for has already been implemented.
+- [ ] I have used the search function to see if someone else has already submitted the same feature request.
+- [ ] I will only create one feature request per issue.
+- [ ] I will describe the problem with as much detail as possible.
-Use the search function to see if someone else has already submitted the same feature request. If there is another request already, please upvote the first post instead of commenting something like "I also want this".
+# System info
-To make it easier for us to keep track of requests, please only make one feature request per issue.
-
-Give a brief explanation about the problem that may currently exist and how your requested feature solves this problem.
-
-Try to be as specific as possible. Please not only explain what the feature does, but also how. If your request is about (or includes) changing or extending the UI, describe what the UI would look like and how the user would interact with it.
--->
-
-<!-- READ THIS: The latest version may be different depending on your device. You can find the version in AntennaPod's settings. -->
+<!-- The latest version may be different depending on your device. You can find the version in AntennaPod's settings. -->
**App version**: x.y.z (state whether from Google Play/F-Droid/Custom built APK)
+# Feature description
**Problem you may be having, or feature you want**:
-
+<!-- Give a brief explanation about the problem that may currently exist -->
**Suggested solution**:
-
+<!-- Describe how your requested feature solves this problem. Try to be as specific as possible. Please not only explain what the feature does, but also how. -->
**Screenshots / Drawings / Technical details**:
+<!-- If your request is about (or includes) changing or extending the UI, describe what the UI would look like and how the user would interact with it. -->