From 5b891a4c1f25f0dd9570605516574db15e61cdcb Mon Sep 17 00:00:00 2001 From: bachinger Date: Tue, 19 Feb 2019 19:36:21 +0000 Subject: [PATCH] add GitHub issue templates according PiperOrigin-RevId: 234641428 --- .../ISSUE_TEMPLATE/bug.md | 53 +++++++++++-------- .github/ISSUE_TEMPLATE/content_not_playing.md | 44 +++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 31 +++++++++++ .github/ISSUE_TEMPLATE/question.md | 31 +++++++++++ 4 files changed, 138 insertions(+), 21 deletions(-) rename ISSUE_TEMPLATE => .github/ISSUE_TEMPLATE/bug.md (53%) create mode 100644 .github/ISSUE_TEMPLATE/content_not_playing.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE/bug.md similarity index 53% rename from ISSUE_TEMPLATE rename to .github/ISSUE_TEMPLATE/bug.md index 8d2f66093d..7e9c631fc0 100644 --- a/ISSUE_TEMPLATE +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -1,13 +1,20 @@ -Before filing an issue: +--- +name: Bug report +about: Issue template for a bug report. +title: '' +labels: bug, 'needs triage' +assignees: '' +--- + +Before filing a bug: ----------------------- - Search existing issues, including issues that are closed. - Consult our FAQs, supported devices and supported formats pages. These can be found at https://google.github.io/ExoPlayer/. - 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. -- This issue tracker is intended for bugs, feature requests and ExoPlayer - specific questions. If you're asking a general Android development question, - please do so on Stack Overflow. + reproduce the issue in the ExoPlayer demo app. Information about the ExoPlayer + demo app can be found here: + http://google.github.io/ExoPlayer/demo-application.html. When reporting a bug: ----------------------- @@ -15,29 +22,33 @@ 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. -### Issue description +### [REQUIRED] Issue description Describe the issue in detail, including observed and expected behavior. -### Reproduction steps -Describe how the issue can be reproduced, ideally using the ExoPlayer demo app. +### [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. -### Link to test content -Provide 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". +### [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". 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. -### Version of ExoPlayer being used -Specify the absolute version number. Avoid using terms such as "latest". - -### 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. - -### A full bug report captured from the device +### [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". +### [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. + diff --git a/.github/ISSUE_TEMPLATE/content_not_playing.md b/.github/ISSUE_TEMPLATE/content_not_playing.md new file mode 100644 index 0000000000..47c09a7a59 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/content_not_playing.md @@ -0,0 +1,44 @@ +--- +name: Content not playing correctly +about: Issue template for a content not playing issue. +title: '' +labels: 'content not playing', 'needs triage' +assignees: '' +--- + +Before filing a content issue: +------------------------------ +- Search existing issues, including issues that are closed. +- Consult our supported formats page, which can be found at + https://google.github.io/ExoPlayer/supported-formats.html. +- Try playing your content in the ExoPlayer demo app. Information about the + ExoPlayer demo app can be found here: + http://google.github.io/ExoPlayer/demo-application.html. + +When reporting a content issue: +----------------------------- +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] Content description +Describe the content and any specifics you expected to play but did not. This +could be the container or sample format itself or any features the stream has +and you expect to play, like 5.1 audio track, text tracks or drm systems. + +### [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". 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. + +### [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 you expect the content to +play. If possible, please test on multiple devices and Android versions. + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..17a07ef39b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,31 @@ +--- +name: Feature request +about: Issue template for a feature request. +title: '' +labels: enhancement, 'needs triage' +assignees: '' +--- + +Before filing a feature request: +----------------------- +- Search existing open issues, specifically with the label ‘enhancement’. +- Search existing pull requests. + +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. + +### [REQUIRED] Use case description +Describe the use case or problem you are trying to solve in detail. If there are +any standards or specifications involved, please provide the relevant details. + +### Proposed solution +A clear and concise description of your proposed solution, if you have one. + +### Alternatives considered +A clear and concise description of any alternative solutions you considered, +if applicable. + + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000000..9d0ddfe4a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,31 @@ +--- +name: Question +about: Issue template for a question. +title: '' +labels: question, 'needs triage' +assignees: '' +--- + +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! +- Consult our FAQs, developer guide and the class reference of ExoPlayer. These + can be found at https://google.github.io/ExoPlayer/. + +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. + +