From 5a02a3b3d9f88f22acd1cfb917e3cf17624b49cb Mon Sep 17 00:00:00 2001
From: Koichiro IWAO
Date: Mon, 29 May 2023 00:07:54 +0900
Subject: [PATCH 1/6] Add issue template: links
---
.github/ISSUE_TEMPLATE/config.yml | 5 +++++
1 file changed, 5 insertions(+)
create mode 100644 .github/ISSUE_TEMPLATE/config.yml
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..ae365ed8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+contact_links:
+ - name: Questions
+ about: If you are new to xrdp and want to ask something, raise it as Q&A in discussion.
+ url: https://github.com/neutrinolabs/xrdp/discussions/new?category=q-a
+
From 650dc032ce481ca174ab23f514df878d139b7d1f Mon Sep 17 00:00:00 2001
From: Koichiro IWAO
Date: Fri, 9 Jun 2023 21:43:12 +0900
Subject: [PATCH 2/6] Add bug report template
---
.github/ISSUE_TEMPLATE/bug_report.yml | 84 +++++++++++++++++++++++++++
1 file changed, 84 insertions(+)
create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 00000000..82ea4bdf
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,84 @@
+name: "🕷️ Bug report"
+description: fofofof
+labels:
+ - "bug"
+body:
+ - type: input
+ attributes:
+ label: xrdp version
+ placeholder: 0.9.20
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Detailed xrdp version, build options
+ description: Copy & paste the result of `xrdp --version`. DO NOT remove `~~~` but paste the result between two `~~~`.
+ value: |
+ ~~~
+ PASTE HERE
+ ~~~
+ - type: input
+ attributes:
+ label: Operating system & version
+ placeholder: "Ubuntu 22.04 / AlmaLinux 9 / FreeBSD 13.2 / etc"
+ description: Tell us about your operating system. See PRETTY_NAME in /etc/os-release if you don't know.
+ validations:
+ required: true
+ - type: dropdown
+ attributes:
+ label: Installation method
+ description: How was xrdp installed from?
+ multiple: true
+ options:
+ - dnf / apt / zypper / pkg / etc
+ - Homebrew / MacPorts
+ - git clone & make install
+ - other
+ validations:
+ required: true
+ - type: input
+ attributes:
+ label: Which backend do you use?
+ description:
+ - type: input
+ attributes:
+ label: What's your client?
+ description: If you issue occurs with specific clients, tell us the client app name, app version client os version and platform.
+ placeholder: Microsoft's official client from Mac App Store, running on macOS Ventura.
+ - type: dropdown
+ attributes:
+ label: Area(s) with issue?
+ multiple: true
+ options:
+ - Audio redirection
+ - Authentication
+ - Crashes such as segfault
+ - Clipboard
+ - Compatiblity aginst clients
+ - Compile error
+ - File transfer / drive redirection
+ - Graphic glitches
+ - Keyboard / Mouse
+ - Network
+ - Performance
+ - Session manager (sesman)
+ - Smartcard
+ - Other
+ - type: textarea
+ attributes:
+ label: Steps to reproduce
+ placeholder: Having detailed steps helps us reproduce the bug.
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: ✔️ Expected Behavior
+ placeholder: What were you expecting?
+ validations:
+ required: false
+ - type: textarea
+ attributes:
+ label: ❌ Actual Behavior
+ placeholder: What happened instead?
+ validations:
+ required: false
From 07797866e33e9ee106a6d4424c0fab585e47d028 Mon Sep 17 00:00:00 2001
From: Koichiro IWAO
Date: Sat, 10 Jun 2023 00:07:01 +0900
Subject: [PATCH 3/6] Update bug report template
---
.github/ISSUE_TEMPLATE/bug_report.yml | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 82ea4bdf..e0bed14c 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -1,5 +1,5 @@
name: "🕷️ Bug report"
-description: fofofof
+description: Report errors or unexpected behavior
labels:
- "bug"
body:
@@ -28,11 +28,11 @@ body:
attributes:
label: Installation method
description: How was xrdp installed from?
- multiple: true
options:
- dnf / apt / zypper / pkg / etc
- Homebrew / MacPorts
- git clone & make install
+ - Doesn't matter
- other
validations:
required: true
@@ -48,6 +48,7 @@ body:
- type: dropdown
attributes:
label: Area(s) with issue?
+ description: What things had an issue? Check all that apply.
multiple: true
options:
- Audio redirection
From afb34f23a4603a529662b6b182270b83b756b849 Mon Sep 17 00:00:00 2001
From: Koichiro IWAO
Date: Sat, 10 Jun 2023 00:26:20 +0900
Subject: [PATCH 4/6] Reword descriptions for the link to Q&A
---
.github/ISSUE_TEMPLATE/config.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index ae365ed8..57f99e83 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,5 @@
contact_links:
- name: Questions
- about: If you are new to xrdp and want to ask something, raise it as Q&A in discussion.
+ about: If you are new to xrdp and want to ask community for help, raise it as Q&A in discussion.
url: https://github.com/neutrinolabs/xrdp/discussions/new?category=q-a
From 416615bfb5f43b4dd1e7af5b4d4b1dc7c5bd485d Mon Sep 17 00:00:00 2001
From: Koichiro IWAO
Date: Tue, 13 Jun 2023 09:38:54 +0900
Subject: [PATCH 5/6] Add field for desktop environment, backend, VM and
anything else
in bug report template
---
.github/ISSUE_TEMPLATE/bug_report.yml | 17 ++++++++++++++++-
1 file changed, 16 insertions(+), 1 deletion(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index e0bed14c..f197c554 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -39,7 +39,17 @@ body:
- type: input
attributes:
label: Which backend do you use?
- description:
+ description: Tell us about xrdp backend and version you're using. Typically, it would be either Xvnc or xorgxrdp or rarely NeutrionRDP / FreeRDP.
+ placeholder: Xvnc (tigervnc-1.12.0-13.el9_2)
+ - type: input
+ attributes:
+ label: What desktop environment do you use?
+ description: Tell us about your desktop (e.g. GNOME / KDE / Xfce / xterm). If you're certain the bug you about to report is not desktop specific, fill "any" here.
+ placeholder: GNOME
+ - type: input
+ attributes:
+ label: Environment xrdp running on
+ description: Tell us whether xrdp is running on a VM, or if on a physical machine what graphics cards are installed.
- type: input
attributes:
label: What's your client?
@@ -83,3 +93,8 @@ body:
placeholder: What happened instead?
validations:
required: false
+ - type: textarea
+ attributes:
+ label: Anything else?
+ description:
+ Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
From 6e192995cb85710ad84b8b302c602e3f3ecd0b2a Mon Sep 17 00:00:00 2001
From: Koichiro IWAO
Date: Tue, 13 Jun 2023 09:50:25 +0900
Subject: [PATCH 6/6] Tip is not allowed here anymore
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
---
.github/ISSUE_TEMPLATE/bug_report.yml | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index f197c554..7975033b 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -96,5 +96,4 @@ body:
- type: textarea
attributes:
label: Anything else?
- description:
- Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+ description: Links? References? Anything that will give us more context about the issue you are encountering! We recommend attaching `xrdp.log`, `xrdp-sesman.log`, `xrdp/xorg.conf` or screenshots to clarify context.