diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 10094cb865..e56037b444 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -6,52 +6,39 @@ labels: bug, needs triage 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: ------------------------ +------------------------- + - Search existing issues, including issues that are closed: https://github.com/google/ExoPlayer/issues?q=is%3Aissue -- Consult our developer website, which can be found at https://exoplayer.dev/. - It provides detailed information about supported formats and devices. -- Learn how to create useful log output by using the EventLogger: - https://exoplayer.dev/debug-logging.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. +- Consult our developer website: https://exoplayer.dev/ +- Check the supported formats: https://exoplayer.dev/supported-formats.html +- Try playing problematic media in the demo app: + http://exoplayer.dev/demo-application.html 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 -or a small sample app that you’re able to share as source code on GitHub. +or a small sample app that you’re 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 -Provide a JSON snippet for the demo app’s media.exolist.json file, 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 dev.exoplayer@gmail.com using a subject -in the format "Issue #1234", where "#1234" should be replaced with your issue -number. Provide all the metadata we'd need to play the content like drm license -urls or similar. If the content is accessible only in certain countries or -regions, please say so. +- Clear reproduction steps including observed and expected behavior +- Output of running "adb bugreport" in the console shortly after encountering + the issue +- URI to test content for reproduction +- For protected content: + - DRM scheme and license server URL + - Authentication HTTP headers -### [REQUIRED] A full bug report captured from the device -Capture a full bug report using "adb bugreport". Output from "adb logcat" or a -log snippet is NOT sufficient. 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. +- ExoPlayer version number +- Android version +- Android device -### [REQUIRED] Version of ExoPlayer being used -Specify the absolute version number. Avoid using terms such as "latest". - -### [REQUIRED] Device(s) and version(s) of Android being used -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. +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). diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index d660d0342a..0019736e88 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -14,9 +14,7 @@ Before filing a feature request: When filing a feature request: ----------------------- -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. +Replace the content in the sections below. ### [REQUIRED] Use case description Describe the use case or problem you are trying to solve in detail. If there are diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index f3ad83b67d..129d3d9974 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -6,45 +6,38 @@ labels: question, needs triage assignees: '' --- +Unfortunately we can't answer all questions. Unclear questions or questions with +insufficient information may not get attention. + 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. -- Search existing issues, including issues that are closed. It’s often the - quickest way to get an answer! +------------------------- + +- Ask general Android development questions on Stack Overflow +- Search existing issues, including issues that are closed https://github.com/google/ExoPlayer/issues?q=is%3Aissue -- Consult our developer website, which can be found at https://exoplayer.dev/. - It provides detailed information about supported formats, devices as well as - information about how to use the ExoPlayer library. -- The ExoPlayer library Javadoc can be found at - https://exoplayer.dev/doc/reference/ +- Consult our developer website (https://exoplayer.dev/) and Javadoc + (https://exoplayer.dev/doc/reference/) 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 you’ve already looked for an answer to your question. It’s -important for us to know this so that we can improve our documentation. - -### [REQUIRED] Question 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, 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. +In case your question refers to a problem you are seeing in your app: -### Link to test content -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 app’s media.exolist.json file, -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 -dev.exoplayer@gmail.com using a subject in the format "Issue #1234", where -"#1234" should be replaced with your issue number. Provide all the metadata we'd -need to play the content like drm license urls or similar. If the content is -accessible only in certain countries or regions, please say so. +- Output of running `$ adb bugreport` in the console + +In case your question is related to a piece of media: + +- URI to test content +- For protected content: + - DRM scheme and license server URL + - Authentication HTTP headers + +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).