From ea9f9af76ccd4be67bbafabb955d1b0ae0eeafdc Mon Sep 17 00:00:00 2001 From: der richter Date: Sat, 4 Jan 2020 13:01:24 +0100 Subject: github: add several issue templates and a warning to not ignore them --- .github/ISSUE_TEMPLATE | 26 --------------- .github/ISSUE_TEMPLATE/1_dont_ignore.md | 16 +++++++++ .github/ISSUE_TEMPLATE/2_bug_report_linux.md | 46 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/2_bug_report_macos.md | 46 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/2_bug_report_windows.md | 44 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/3_bug_report.md | 40 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/4_bug_report_build.md | 30 +++++++++++++++++ .github/ISSUE_TEMPLATE/5_feature_request.md | 15 +++++++++ .github/ISSUE_TEMPLATE/6_question.md | 11 ++++++ .github/ISSUE_TEMPLATE/config.yml | 9 +++++ 10 files changed, 257 insertions(+), 26 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE create mode 100644 .github/ISSUE_TEMPLATE/1_dont_ignore.md create mode 100644 .github/ISSUE_TEMPLATE/2_bug_report_linux.md create mode 100644 .github/ISSUE_TEMPLATE/2_bug_report_macos.md create mode 100644 .github/ISSUE_TEMPLATE/2_bug_report_windows.md create mode 100644 .github/ISSUE_TEMPLATE/3_bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/4_bug_report_build.md create mode 100644 .github/ISSUE_TEMPLATE/5_feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/6_question.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE deleted file mode 100644 index 4a62016ff3..0000000000 --- a/.github/ISSUE_TEMPLATE +++ /dev/null @@ -1,26 +0,0 @@ -### mpv version and platform - -If you're not using git master or the latest release, update. -Releases are listed here: https://github.com/mpv-player/mpv/releases - -### Reproduction steps - -### Expected behavior - -### Actual behavior - -### Log file - -Make a log file made with -v -v or --log-file=output.txt, paste it to -https://0x0.st/ or attach it to the github issue, and replace this text with a -link to it. If the issue is a build failure, upload build/config.log instead. - -If this is a normal runtime bug, and no log is provided, the issue will be -closed for ignoring the issue template. This is because analyzing a bug without -a log file is harder than necessary. Low quality bug reports are noise. - -### Sample files - -Sample files needed to reproduce this issue can be uploaded to https://0x0.st/ -or similar sites. (Only needed if the issue cannot be reproduced without it.) -Do not use garbage like "cloud storage", especially not Google Drive. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/1_dont_ignore.md b/.github/ISSUE_TEMPLATE/1_dont_ignore.md new file mode 100644 index 0000000000..578d5604fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_dont_ignore.md @@ -0,0 +1,16 @@ +--- +name: 'README: DO NOT IGNORE OR DELETE THE ISSUE TEMPLATE' +about: 'Chose and fill out one of the following templates!' +title: '' +labels: priority:ignored-issue-template +assignees: '' + +--- + +We ask you to not ignore the issue template. Fill it out as good and correct as +possible. Issues that don't adhere to our request will be closed for ignoring +the issue template. This is because analyzing a bug without a log file is harder +than necessary. Low quality bug reports are noise. + +Please go back and chose the proper issue template. Opening issues with this +template will be closed immediately. diff --git a/.github/ISSUE_TEMPLATE/2_bug_report_linux.md b/.github/ISSUE_TEMPLATE/2_bug_report_linux.md new file mode 100644 index 0000000000..36662da6ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_bug_report_linux.md @@ -0,0 +1,46 @@ +--- +name: 'Report a Linux Bug' +about: 'Create a report for a runtime related Linux Bug' +title: '' +labels: 'os:linux' +assignees: '' + +--- + +### Important Information + +Provide following Information: +- mpv version +- Linux Distribution and Version +- Source of the mpv binary +- If known which version of mpv introduced the problem +- Window Manager and version +- GPU driver and version +- Possible screenshot or video of visual glitches + +If you're not using git master or the latest release, update. +Releases are listed here: https://github.com/mpv-player/mpv/releases + +### Reproduction steps + +Describe the reproduction steps as precise as possible. It's very likely that +the bug you experience wasn't reproduced by the developer because the workflow +differes from your own. + +### Expected behavior + +### Actual behavior + +### Log file + +Make a log file made with -v -v or --log-file=output.txt, paste it to +https://0x0.st/ or attach it to the github issue, and replace this text with a +link to it. + +The issue will be closed for ignoring the issue template. + +### Sample files + +Sample files needed to reproduce this issue can be uploaded to https://0x0.st/ +or similar sites. (Only needed if the issue cannot be reproduced without it.) +Do not use garbage like "cloud storage", especially not Google Drive. diff --git a/.github/ISSUE_TEMPLATE/2_bug_report_macos.md b/.github/ISSUE_TEMPLATE/2_bug_report_macos.md new file mode 100644 index 0000000000..8fe40cfba6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_bug_report_macos.md @@ -0,0 +1,46 @@ +--- +name: 'Report a macOS Bug' +about: 'Create a report for a runtime related macOS Bug' +title: '' +labels: 'os:mac' +assignees: '' + +--- + +### Important Information + +Provide following Information: +- mpv version +- macOS Version +- Source of the mpv binary or bundle +- If known which version of mpv introduced the problem +- Possible screenshot or video of visual glitches + +If you're not using git master or the latest release, update. +Releases are listed here: https://github.com/mpv-player/mpv/releases + +### Reproduction steps + +Describe the reproduction steps as precise as possible. It's very likely that +the bug you experience wasn't reproduced by the developer because the workflow +differes from your own. + +### Expected behavior + +### Actual behavior + +### Log file + +Make a log file made with -v -v or --log-file=output.txt, paste it to +https://0x0.st/ or attach it to the github issue, and replace this text with a +link to it. + +In the case of a crash please provide the macOS Crash Report (Backtrace). + +The issue will be closed for ignoring the issue template. + +### Sample files + +Sample files needed to reproduce this issue can be uploaded to https://0x0.st/ +or similar sites. (Only needed if the issue cannot be reproduced without it.) +Do not use garbage like "cloud storage", especially not Google Drive. diff --git a/.github/ISSUE_TEMPLATE/2_bug_report_windows.md b/.github/ISSUE_TEMPLATE/2_bug_report_windows.md new file mode 100644 index 0000000000..7df7fadd19 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_bug_report_windows.md @@ -0,0 +1,44 @@ +--- +name: 'Report a Windows Bug' +about: 'Create a report for a runtime related Windows Bug' +title: '' +labels: 'os:win' +assignees: '' + +--- + +### Important Information + +Provide following Information: +- mpv version +- Windows Version +- Source of the mpv binary +- If known which version of mpv introduced the problem +- Possible screenshot or video of visual glitches + +If you're not using git master or the latest release, update. +Releases are listed here: https://github.com/mpv-player/mpv/releases + +### Reproduction steps + +Describe the reproduction steps as precise as possible. It's very likely that +the bug you experience wasn't reproduced by the developer because the workflow +differes from your own. + +### Expected behavior + +### Actual behavior + +### Log file + +Make a log file made with -v -v or --log-file=output.txt, paste it to +https://0x0.st/ or attach it to the github issue, and replace this text with a +link to it. + +The issue will be closed for ignoring the issue template. + +### Sample files + +Sample files needed to reproduce this issue can be uploaded to https://0x0.st/ +or similar sites. (Only needed if the issue cannot be reproduced without it.) +Do not use garbage like "cloud storage", especially not Google Drive. diff --git a/.github/ISSUE_TEMPLATE/3_bug_report.md b/.github/ISSUE_TEMPLATE/3_bug_report.md new file mode 100644 index 0000000000..5032a0d5d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_bug_report.md @@ -0,0 +1,40 @@ +--- +name: 'Report a Bug for a different Platform' +about: 'Create a report for a runtime related Bug' +title: '' +labels: '' +assignees: '' + +--- + +### Important Information + +Provide following Information: +- mpv version +- Platform and Version +- Source of the mpv binary + +If you're not using git master or the latest release, update. +Releases are listed here: https://github.com/mpv-player/mpv/releases + +### Reproduction steps + +Describe the reproduction steps as precise as possible. It's very likely that +the bug you experience wasn't reproduced by the developer because the workflow +differes from your own. + +### Expected behavior + +### Actual behavior + +### Log file + +Make a log file made with -v -v or --log-file=output.txt, paste it to +https://0x0.st/ or attach it to the github issue, and replace this text with a +link to it. + +### Sample files + +Sample files needed to reproduce this issue can be uploaded to https://0x0.st/ +or similar sites. (Only needed if the issue cannot be reproduced without it.) +Do not use garbage like "cloud storage", especially not Google Drive. diff --git a/.github/ISSUE_TEMPLATE/4_bug_report_build.md b/.github/ISSUE_TEMPLATE/4_bug_report_build.md new file mode 100644 index 0000000000..5c7fae661f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_bug_report_build.md @@ -0,0 +1,30 @@ +--- +name: 'Report a build Problem' +about: 'Create a report for a build related Bug' +title: '' +labels: 'core:waf' +assignees: '' + +--- + +### mpv version and platform versions + +If you're not using git master or the latest release, update. +Releases are listed here: https://github.com/mpv-player/mpv/releases + +### Reproduction steps + +Describe the reproduction steps as precise as possible. It's very likely that +the bug you experience wasn't reproduced by the developer because the workflow +differes from your own. + +### Expected behavior + +### Actual behavior + +### Log file + +Upload build/config.log or ./waf configure output to https://0x0.st/ or attach +it to the github issue, and replace this text with a link to it. + +The issue will be closed for ignoring the issue template. diff --git a/.github/ISSUE_TEMPLATE/5_feature_request.md b/.github/ISSUE_TEMPLATE/5_feature_request.md new file mode 100644 index 0000000000..1ad3da4a0f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/5_feature_request.md @@ -0,0 +1,15 @@ +--- +name: 'Request a new Feature' +about: 'Create a request for a new feature' +title: '' +labels: 'meta:feature-request' +assignees: '' + +--- + +Before requesting a new feature make sure it hasn't been requested yet. +https://github.com/mpv-player/mpv/labels/meta%3Afeature-request + +### Expected behavior of the wanted feature + +### Alternative behavior of the wanted feature diff --git a/.github/ISSUE_TEMPLATE/6_question.md b/.github/ISSUE_TEMPLATE/6_question.md new file mode 100644 index 0000000000..12537414db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/6_question.md @@ -0,0 +1,11 @@ +--- +name: 'Ask a Question' +about: 'Ask a question about mpv' +title: '' +labels: 'meta:question' +assignees: '' + +--- + +Before asking a question make sure it hasn't been asked or answered yet. +https://github.com/mpv-player/mpv/labels/meta%3Aquestion diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..ece4d0cabd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ +blank_issues_enabled: false +contact_links: + - name: mpv irc channel + url: https://mpv.io/community/ + about: Feel free to ask question here irc://irc.freenode.net/mpv + - name: mpv irc developer channel + url: https://mpv.io/community/ + about: Ask question related to the development of mpv here + irc://irc.freenode.net/mpv-devel -- cgit v1.2.3