summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md33
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md16
-rw-r--r--.github/pull_request_template.md2
3 files changed, 24 insertions, 27 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index a1c983d1d..16a12484e 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -5,49 +5,46 @@ labels: 'possible bug'
---
# Checklist
-[comment]: Place an x in the boxes to tick them: [x]
+<!-- Place an x in the boxes to tick them: [x] -->
- [ ] 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.
# System info
-[comment]: The following information is very important to fill out because some bugs may only occur on certain devices or versions of Android.
+<!-- The following information is very important to fill out because some bugs may only occur on certain devices or versions of Android. -->
-**AntennaPod version**: x.y.z
-[comment]: The latest version may be different depending on your device. You can find the version in AntennaPod's settings.
+**App version**: x.y.z
+<!-- The latest version may be different depending on your device. You can find the version in AntennaPod's settings. -->
**App source**: Google Play / F-Droid / ...
-[comment]: Please delete irrelevant answers or fill in the blank.
+<!-- Please delete irrelevant answer or fill in the blank -->
-**Android version**: x.y
-[comment]: Please mention if you are using a custom rom!
+**Android version**: 5.x (Please mention if you are using a custom rom!)
**Device model**:
# Bug description
**Steps to reproduce**:
-1. Go to
-2. Tap on
-3. Then do
-4. See error
+1. This
+2. Then that
+3. Then this
+4. Etc.
**Expected behaviour**:
-[comment]: After following the steps, what did you think AntennaPod would do?
+<!-- After following the steps, what did you think AntennaPod would do? -->
**Current behaviour**:
-[comment]: 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.
+<!-- 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**:
-[comment]: How many days or weeks ago you noticed this for the first time.
+**First occurred**: (e.g. about x days/weeks ago)
**Environment**:
-[comment]: Settings you have changed (e.g. Auto Download, changed media player). "Unusual" devices you use (e.g. Bluetooth headphones).
+<!-- Settings you have changed (e.g. Auto Download, changed media player). "Unusual" devices you use (e.g. Bluetooth headphones). -->
**Stacktrace/Logcat**:
-[comment]: If you are experiencing a crash, including the stacktrace will likely get it fixed sooner. AntennaPod has an `export logs` feature for this.
-[comment]: You can delete this section if you don't have logs to share.
+<!-- 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/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index befc7a05a..24f2f5772 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -5,7 +5,7 @@ about: Request a new feature or enhancement
---
# Checklist
-[comment]: Place an x in the boxes to tick them: [x]
+<!-- Place an x in the boxes to tick them: [x] -->
- [ ] 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.
@@ -14,18 +14,18 @@ about: Request a new feature or enhancement
# System info
**App version**: x.y.z
-[comment]: 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 source**: Google Play / F-Droid / ...
-[comment]: Please delete irrelevant answers or fill in the blank.
+<!-- Please delete irrelevant answer or fill in the blank -->
# Feature description
-**Problem you may be having, or feature that could be improved**:
-[comment]: Give a brief explanation about the problem that may currently exist. E.g. 'I find it annoying when I have to...'
+**Problem you may be having, or feature you want**:
+<!-- Give a brief explanation about the problem that may currently exist -->
-**Solution you would like to have**:
-[comment]: Describe how your requested feature solves this problem. Try to be as specific as possible. Please don't just explain what the feature does, but also how.
+**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**:
-[comment]: 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.
+<!-- 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. -->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 57563447b..f9fea783a 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1 +1 @@
-[comment]: Please make sure that you have read our contribution guidelines: https://github.com/AntennaPod/AntennaPod/blob/develop/CONTRIBUTING.md#submit-a-pull-request
+<!-- Please make sure that you have read our contribution guidelines: https://github.com/AntennaPod/AntennaPod/blob/develop/CONTRIBUTING.md#submit-a-pull-request -->