Make issue templates shorter

PiperOrigin-RevId: 345624512
This commit is contained in:
bachinger 2020-12-04 08:46:52 +00:00 committed by Ian Baker
parent 0f64ace515
commit 32e68f608b
3 changed files with 54 additions and 76 deletions

View File

@ -6,52 +6,39 @@ labels: bug, needs triage
assignees: '' assignees: ''
--- ---
We can only process bug reports that are actionable. Unclear bug reports or
reports with insufficient information may not get attention.
Before filing a bug: Before filing a bug:
----------------------- -------------------------
- Search existing issues, including issues that are closed: - Search existing issues, including issues that are closed:
https://github.com/google/ExoPlayer/issues?q=is%3Aissue https://github.com/google/ExoPlayer/issues?q=is%3Aissue
- Consult our developer website, which can be found at https://exoplayer.dev/. - Consult our developer website: https://exoplayer.dev/
It provides detailed information about supported formats and devices. - Check the supported formats: https://exoplayer.dev/supported-formats.html
- Learn how to create useful log output by using the EventLogger: - Try playing problematic media in the demo app:
https://exoplayer.dev/debug-logging.html http://exoplayer.dev/demo-application.html
- Rule out issues in your own code. A good way to do this is to try and
reproduce the issue in the ExoPlayer demo app. Information about the ExoPlayer
demo app can be found here:
http://exoplayer.dev/demo-application.html.
When reporting a bug: When reporting a bug:
----------------------- -------------------------
Fill out the sections below, leaving the headers but replacing the content. If
you're unable to provide certain information, please explain why in the relevant
section. We may close issues if they do not include sufficient information.
### [REQUIRED] Issue description
Describe the issue in detail, including observed and expected behavior.
### [REQUIRED] Reproduction steps
Describe how the issue can be reproduced, ideally using the ExoPlayer demo app Describe how the issue can be reproduced, ideally using the ExoPlayer demo app
or a small sample app that youre able to share as source code on GitHub. or a small sample app that youre able to share as source code on GitHub. To
increase the chance of your issue getting attention, please also include:
### [REQUIRED] Link to test content - Clear reproduction steps including observed and expected behavior
Provide a JSON snippet for the demo apps media.exolist.json file, or a link to - Output of running "adb bugreport" in the console shortly after encountering
media that reproduces the issue. If you don't wish to post it publicly, please the issue
submit the issue, then email the link to dev.exoplayer@gmail.com using a subject - URI to test content for reproduction
in the format "Issue #1234", where "#1234" should be replaced with your issue - For protected content:
number. Provide all the metadata we'd need to play the content like drm license - DRM scheme and license server URL
urls or similar. If the content is accessible only in certain countries or - Authentication HTTP headers
regions, please say so.
### [REQUIRED] A full bug report captured from the device - ExoPlayer version number
Capture a full bug report using "adb bugreport". Output from "adb logcat" or a - Android version
log snippet is NOT sufficient. Please attach the captured bug report as a file. - Android device
If you don't wish to post it publicly, please submit the issue, then email the
bug report to dev.exoplayer@gmail.com using a subject in the format
"Issue #1234", where "#1234" should be replaced with your issue number.
### [REQUIRED] Version of ExoPlayer being used If there's something you don't want to post publicly, please submit the issue,
Specify the absolute version number. Avoid using terms such as "latest". then email the link/bug report to dev.exoplayer@gmail.com using a subject in the
format "Issue #1234", where #1234 is your issue number (we don't reply to
### [REQUIRED] Device(s) and version(s) of Android being used emails).
Specify the devices and versions of Android on which the issue can be
reproduced, and how easily it reproduces. If possible, please test on multiple
devices and Android versions.

View File

@ -14,9 +14,7 @@ Before filing a feature request:
When filing a feature request: When filing a feature request:
----------------------- -----------------------
Fill out the sections below, leaving the headers but replacing the content. If Replace the content in the sections below.
you're unable to provide certain information, please explain why in the relevant
section. We may close issues if they do not include sufficient information.
### [REQUIRED] Use case description ### [REQUIRED] Use case description
Describe the use case or problem you are trying to solve in detail. If there are Describe the use case or problem you are trying to solve in detail. If there are

View File

@ -6,45 +6,38 @@ labels: question, needs triage
assignees: '' assignees: ''
--- ---
Unfortunately we can't answer all questions. Unclear questions or questions with
insufficient information may not get attention.
Before filing a question: Before filing a question:
----------------------- -------------------------
- This issue tracker is intended ExoPlayer specific questions. If you're asking
a general Android development question, please do so on Stack Overflow. - Ask general Android development questions on Stack Overflow
- Search existing issues, including issues that are closed. Its often the - Search existing issues, including issues that are closed
quickest way to get an answer!
https://github.com/google/ExoPlayer/issues?q=is%3Aissue https://github.com/google/ExoPlayer/issues?q=is%3Aissue
- Consult our developer website, which can be found at https://exoplayer.dev/. - Consult our developer website (https://exoplayer.dev/) and Javadoc
It provides detailed information about supported formats, devices as well as (https://exoplayer.dev/doc/reference/)
information about how to use the ExoPlayer library.
- The ExoPlayer library Javadoc can be found at
https://exoplayer.dev/doc/reference/
When filing a question: When filing a question:
----------------------- -------------------------
Fill out the sections below, leaving the headers but replacing the content. If
you're unable to provide certain information, please explain why in the relevant
section. We may close issues if they do not include sufficient information.
### [REQUIRED] Searched documentation and issues
Tell us where youve already looked for an answer to your question. Its
important for us to know this so that we can improve our documentation.
### [REQUIRED] Question
Describe your question in detail. Describe your question in detail.
### A full bug report captured from the device In case your question refers to a problem you are seeing in your app:
In case your question refers to a problem you are seeing in your app, capture a
full bug report using "adb bugreport". Please attach the captured bug report as
a file. If you don't wish to post it publicly, please submit the issue, then
email the bug report to dev.exoplayer@gmail.com using a subject in the format
"Issue #1234", where "#1234" should be replaced with your issue number.
### Link to test content - Output of running `$ adb bugreport` in the console
In case your question is related to a piece of media, which you are trying to
play, please provide a JSON snippet for the demo apps media.exolist.json file, In case your question is related to a piece of media:
or a link to media that reproduces the issue. If you don't wish to post it
publicly, please submit the issue, then email the link to - URI to test content
dev.exoplayer@gmail.com using a subject in the format "Issue #1234", where - For protected content:
"#1234" should be replaced with your issue number. Provide all the metadata we'd - DRM scheme and license server URL
need to play the content like drm license urls or similar. If the content is - Authentication HTTP headers
accessible only in certain countries or regions, please say so.
Don't forget to check supported formats and devices
(https://exoplayer.dev/supported-formats.html).
If there's something you don't want to post publicly, please submit the issue,
then email the link/bug report to dev.exoplayer@gmail.com using a subject in the
format "Issue #1234", where #1234 is your issue number (we don't reply to
emails).