From 1d3b6dac6962d67d91b6e5ec93a39d99c5f44641 Mon Sep 17 00:00:00 2001 From: Fr_Dae Date: Wed, 3 Jul 2024 11:49:01 +0200 Subject: [PATCH 1/5] Improve bug report template Use titles and capital letters. PR #5051 Signed-off-by: Romain Vimont --- .github/ISSUE_TEMPLATE/bug_report.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1c04da7f..c06ac786 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,14 +10,16 @@ assignees: '' - [ ] I have read the [FAQ](https://github.com/Genymobile/scrcpy/blob/master/FAQ.md). - [ ] I have searched in existing [issues](https://github.com/Genymobile/scrcpy/issues). -**Environment** - - OS: [e.g. Debian, Windows, macOS...] - - scrcpy version: [e.g. 1.12.1] - - installation method: [e.g. manual build, apt, snap, brew, Windows release...] - - device model: - - Android version: [e.g. 10] +## Environment + + - **OS:** [e.g. Debian, Windows, macOS...] + - **Scrcpy version:** [e.g. 1.12.1] + - **Installation method:** [e.g. manual build, apt, snap, brew, Windows release...] + - **Device model:** + - **Android version:** [e.g. 10] + +## Describe the bug -**Describe the bug** A clear and concise description of what the bug is. On errors, please provide the output of the console (and `adb logcat` if relevant). From 126da0cb18576cc40b9506c676af3a2d569c760c Mon Sep 17 00:00:00 2001 From: Romain Vimont Date: Fri, 5 Jul 2024 23:57:33 +0200 Subject: [PATCH 2/5] Rework bug report template checks Remove explicit checkboxes, and add a link to prerequisites. --- .github/ISSUE_TEMPLATE/bug_report.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c06ac786..977f2d8d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,8 +7,14 @@ assignees: '' --- - - [ ] I have read the [FAQ](https://github.com/Genymobile/scrcpy/blob/master/FAQ.md). - - [ ] I have searched in existing [issues](https://github.com/Genymobile/scrcpy/issues). +_Please read the [prerequisites] to run scrcpy._ + +[prerequisites]: https://github.com/Genymobile/scrcpy#prerequisites + +_Also read the [FAQ] and check if your [issue][issues] already exists._ + +[FAQ]: https://github.com/Genymobile/scrcpy/blob/master/FAQ.md +[issues]: https://github.com/Genymobile/scrcpy/issues ## Environment From cc8e6133b0c9975ef2ed16086960e822ab750404 Mon Sep 17 00:00:00 2001 From: Romain Vimont Date: Fri, 5 Jul 2024 23:58:00 +0200 Subject: [PATCH 3/5] Upgrade default versions in bug report template --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 977f2d8d..576d4666 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -19,10 +19,10 @@ _Also read the [FAQ] and check if your [issue][issues] already exists._ ## Environment - **OS:** [e.g. Debian, Windows, macOS...] - - **Scrcpy version:** [e.g. 1.12.1] + - **Scrcpy version:** [e.g. 2.5] - **Installation method:** [e.g. manual build, apt, snap, brew, Windows release...] - **Device model:** - - **Android version:** [e.g. 10] + - **Android version:** [e.g. 14] ## Describe the bug From 65bd6bd8d4cd16baf44a80911b67afcfa8615106 Mon Sep 17 00:00:00 2001 From: Romain Vimont Date: Fri, 19 Jul 2024 17:51:50 +0200 Subject: [PATCH 4/5] Explicitly accept issues for general questions Add an empty question template, and reword the "Contact" section in the README. Refs #5117 --- .github/ISSUE_TEMPLATE/question.md | 8 ++++++++ README.md | 7 +++++-- 2 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..14dc373a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,8 @@ +--- +name: Question +about: Ask a question about scrcpy +title: '' +labels: '' +assignees: '' + +--- diff --git a/README.md b/README.md index 3185652b..36c8c272 100644 --- a/README.md +++ b/README.md @@ -148,11 +148,14 @@ documented in the following pages: ## Contact -If you encounter a bug, please read the [FAQ](FAQ.md) first, then open an [issue]. +You can open an [issue] for bug reports, feature requests or general questions. + +For bug reports, please read the [FAQ](FAQ.md) first, you might find a solution +to your problem immediately. [issue]: https://github.com/Genymobile/scrcpy/issues -For general questions or discussions, you can also use: +You can also use: - Reddit: [`r/scrcpy`](https://www.reddit.com/r/scrcpy) - Twitter: [`@scrcpy_app`](https://twitter.com/scrcpy_app) From bbfac9ae1fba08a045557abe9612703ace8a3890 Mon Sep 17 00:00:00 2001 From: Romain Vimont Date: Fri, 19 Jul 2024 17:56:26 +0200 Subject: [PATCH 5/5] Add FUNDING.yml The donation links were already in the README. Also add them in the format expected by GitHub in FUNDING.yml. --- .github/FUNDING.yml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..b567129a --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +github: [rom1v] +liberapay: rom1v +custom: ["https://paypal.me/rom2v"]