Castopod
/
AntennaPod
mirror of https://github.com/AntennaPod/AntennaPod.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix up CONTRIBUTING and the issue templates

This commit is contained in:
TacoTheDank 2020-05-06 16:34:01 -04:00
parent 63be7a97b8
commit 571c62699a
3 changed files with 49 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -9,14 +9,26 @@ DELETE ME
Use the search function to see if someone else has already submitted the same bug report.
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. You can create logfiles with apps like `aLogcat`. Just launch `alogcat`, then start AntennaPod and reproduce the bug. aLogcat should now display information about the bug when you start it. AntennaPod also has an `export logs` feature.
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.
-->
**App version**: 1.x (from Google Play/F-Droid/Custom build)
**App version**: 1.x (state whether from Google Play/F-Droid/Custom built APK)
**Android version**: 5.x [Please mention if you are using a custom rom!]
**Android version**: 5.x (Please mention if you are using a custom rom!)
**Device model**:
@ -24,15 +36,15 @@ If you are experiencing a crash, including the stacktrace will likely get it fix
**Current behaviour**:
**First occurred**: Version 1.x / about x days/weeks ago
**First occurred**: (e.g. about x days/weeks ago)
**Steps to reproduce**:
1. This
1. Than that
1. Then
2. Then that
3. Then this
4. Etc.
**Environment**: [Settings you have changed, e.g. Auto Download. "Unusual" devices you use, e.g. Bluetooth headphones. Did you select another media player?]
**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**:
```

12
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -7,18 +7,20 @@ about: Request a new feature
<!--
DELETE ME
Use the search function to see if someone else has already submitted the same feature request. If there already is another request, please upvote the first post instead of commenting something like "I also want this".
Make sure you are using the latest version of AntennaPod. Perhaps the feature you are looking for has already been implemented.
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".
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 currently exists and why your requested feature solves this problem.
Give a brief explanation about the problem that may currently exist and how your requested feature solves this problem.
Try do be as specific as possible. Please not only explain what the feature does, but also how. When your request is about changing or extending the UI, describe what the UI would look like and how the user would interact with it.
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.
-->
**App version**: 1.x (from Google Play/F-Droid/Custom build)
**App version**: 1.x (state whether from Google Play/F-Droid/Custom built APK)
**Problem you are having**:
**Problem you may be having**:
**Suggested solution**:

70
CONTRIBUTING.md
View File

@ -1,63 +1,39 @@
How to report a bug
-------------------
- Use the search function to see if someone else has already reported the bug. If an issue has already been opened, see if you can add any useful information to it.
- Otherwise, create a new issue on the "issues" page
- Describe the problem as detailed as possible.
- Some bugs 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, make sure to include the URL of that podcast.
- Use the search function to see if someone else has already submitted the same bug report.
- 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. You can create logfiles with an app like `aLogcat`. Just launch `alogcat`, then start AntennaPod and reproduce the bug. aLogcat should now display information about the bug when you start it.
- Usually, you can make a screenshot of your smartphone by pressing [Power] + [Volume down] for a few seconds
- Please use the following **template**:
**App version**: 1.x (from Google Play/F-Store/Custom build)
**Android version**: 5.x [Especially mention custom roms!]
**Device model**:
**Expected behaviour**:
**Current behaviour**:
**First occured**: Version 1.x / about x days/weeks ago
**Steps to reproduce**:
1. Do this
1. Do that
**Environment**: Settings you have changed, e.g. Auto Download. "Unusual" devices you use, e.g. Bluetooth headphones.
**Stacktrace/Logcat**: [if available]
```
...
```
- If possible, add a logfile to your post. This is especially useful if the bug makes the application crash. You can create logfiles with apps like `aLogcat`. Just launch `alogcat`, then start AntennaPod and reproduce the bug. aLogcat should now display information about the bug when you start it. AntennaPod also has an `export logs` feature.
- Usually, you can take a screenshot of your smartphone by pressing *Power* + *Volume down* for a few seconds.
- Please use the following **[template](.github/ISSUE_TEMPLATE/bug_report.md)**.
How to submit a feature request
-------------------------------
- Make sure you are using the latest version of AntennaPod. Perhaps the feature you are looking for has already been implemented.
- Use the search function to see if someone else has already submitted the same feature request.
- If an issue has already been opened, see if you can add anything useful to it.
- Otherwise, create a new issue on the "issues" page
- 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 currently exists and why your requested feature solves this problem.
- Try do be as specific as possible. Please not only explain *what* the feature does, but also *how*. When your request is about changing or extending the UI, describe what the UI would look like and how the user would interact with it.
- 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".
- 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.
Translating AntennaPod
----------------------
If you would like to translate the app into another language or improve an existing translation, you can visit the [Transifex project page](https://www.transifex.com/projects/p/antennapod/). From there, you can either join a language team if it already exists or create a new language team.
If you would like to translate the app into another language or improve an existing translation, you can visit the [Transifex project page](https://www.transifex.com/antennapod/antennapod/). From there, you can either join a language team if it already exists or create a new language team.
Submit a pull-request
Submit a pull request
---------------------
- If you want to work on a feature that has been requested or fix a bug that has been reported on the "issues" page, add a comment to it so that other people know that you are working on it.
- Fork the repository
- Almost all changes of AntennaPod are done on the `develop` branch. If a new version of AntennaPod is released, the `develop` branch is merged into `master`. As a result, the `master` branch probably doesn't contain the latest changes when you are reading this. Please make sure that you are branching from `develop`! Otherwise, there might be a lot of merge-conflicts when merging your changes into `develop` and therefore it might take longer to review your pull-request. Exceptions are changes in files like README.md, CONTRIBUTING.md and other files that are not directly related to the source code.
- If your pull-request fixes a bug that has been reported or implements a feature that has been requested in another issue, try to mention it so that it can be closed once your pull-request has been merged. If you use special keywords in the [commit comment](https://help.github.com/articles/closing-issues-via-commit-messages/) or [pull request text](https://github.com/blog/1506-closing-issues-via-pull-requests) github will close the issues automatically when the changes lands at the master branch.
- Although not every part of AntennaPod's source code is fully documented yet, it would be very nice if you could add documentation to your changes if it is a larger pull-request.
- If possible, add unit tests for your pull-request and make sure that they pass. Information on how to add unit tests and run them can be found here: [TODO]
- If you want to work on a feature that has been requested or fix a bug that has been reported on the "issues" page, add a comment to it so that other people know that you are working on it.
- Fork the repository.
- Almost all changes of AntennaPod are done on the `develop` branch. If a new version of AntennaPod is released, the `develop` branch is merged into `master`. As a result, the `master` branch probably doesn't contain the latest changes when you are reading this. Please make sure that you are branching from `develop`! Otherwise, there might be a lot of merge-conflicts when merging your changes into `develop` and therefore it might take longer to review your pull-request. Exceptions are changes in files like README.md, CONTRIBUTING.md, and other files that are not directly related to the source code.
- If your pull request fixes a bug that has been reported or implements a feature that has been requested in another issue, try to mention it so that it can be closed once your pull request has been merged. If you use special keywords in the [commit comment](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) or [pull request text](https://github.blog/2013-05-14-closing-issues-via-pull-requests/), GitHub will close the issue(s) automatically when the changes land on the master branch.
- Although not every part of AntennaPod's source code is fully documented yet, it would be very nice if you could add documentation to your changes if it is a larger pull request.
- If possible, add unit tests for your pull request and make sure that they pass. Information on how to add unit tests and run them can be found here: (TODO)
Improving this file
-------------------
If you think this file needs clarification or additional information on certain topics, feel free to improve it via pull-requests or ask a question on the issues section.
If you think this file needs clarification or additional information on certain topics, feel free to improve it via pull requests or by opening an issue.