From 1efe2e16a5e211116102b46fca8e837e9ce9bcb4 Mon Sep 17 00:00:00 2001 From: Robert Ellegate Date: Sat, 8 Apr 2023 13:37:07 -0400 Subject: [PATCH 1/3] =?UTF-8?q?=F0=9F=93=9D=20chore(github):=20add=20issue?= =?UTF-8?q?=20templates=20for=20bug=20report,=20feature=20request,=20and?= =?UTF-8?q?=20question=20The=20issue=20templates=20for=20bug=20report,=20f?= =?UTF-8?q?eature=20request,=20and=20question=20have=20been=20added=20to?= =?UTF-8?q?=20the=20`.github/ISSUE=5FTEMPLATE`=20directory.=20These=20temp?= =?UTF-8?q?lates=20will=20help=20standardize=20the=20information=20provide?= =?UTF-8?q?d=20in=20issues=20and=20make=20it=20easier=20for=20contributors?= =?UTF-8?q?=20to=20provide=20the=20necessary=20information.=20The=20bug=20?= =?UTF-8?q?report=20template=20includes=20checkboxes=20to=20ensure=20that?= =?UTF-8?q?=20the=20FAQ=20has=20been=20checked=20and=20open=20issues=20hav?= =?UTF-8?q?e=20been=20searched=20before=20submitting=20a=20new=20bug=20rep?= =?UTF-8?q?ort.=20The=20feature=20request=20template=20is=20a=20simple=20t?= =?UTF-8?q?emplate=20for=20suggesting=20new=20ideas=20for=20the=20project.?= =?UTF-8?q?=20The=20question=20template=20asks=20for=20the=20version=20of?= =?UTF-8?q?=20Keepass2Android=20being=20used=20to=20help=20with=20troubles?= =?UTF-8?q?hooting.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.yaml | 49 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 8 ++++ .github/ISSUE_TEMPLATE/question.md | 16 ++++++++ 3 files changed, 73 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..224c50a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,49 @@ +name: Bug Report +description: Report a bug. +title: "[BUG] " +labels: bug +body: + - type: markdown + attributes: + value: | + Please check out the [FAQ section](https://github.com/PhilippC/keepass2android/blob/master/docs/Documentation.md#faq) and [search for open issues](https://github.com/PhilippC/keepass2android/issues?q=is%3Aopen+is%3Aissue+label%3Abug) first. + - type: checkboxes + attributes: + label: Checks + options: + - label: I have read the FAQ section, searched the open issues, and still think this is a new bug. + required: true + - type: textarea + id: bug + attributes: + label: "Describe the bug you encountered:" + validations: + required: true + - type: textarea + id: expected + attributes: + label: "Describe what you expected to happen:" + - type: input + id: version + attributes: + label: "What version of Keepass2Android are you using?" + placeholder: | + Please follow these steps to find your app version: + 1. Click the **⁝** icon in the top right corner + 2. Select **Settings** + 3. Click **About** + 4. Find the "Version" information and provide it here + validations: + required: true + - type: textarea + id: os + attributes: + label: Which version of Android are you on? + placeholder: | + Please follow these steps to find your Android version: + 1. Open your device's **Settings** app. + 2. Scroll down and select **About phone** or **About tablet**. + 3. Find the **Android version** section and provide it here. + validations: + required: true + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..3b69df7a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,8 @@ +--- +name: Feature Request +about: Suggest an idea for this project. +title: '' +labels: enhancement +assignees: '' + +--- diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..b3d154c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,16 @@ +--- +name: Question +about: Ask a question about 'Keepass2Android'. +title: '' +labels: question +assignees: '' + +--- + +**What version of Keepass2Android are you using?** +Please follow these steps to find your app version: +1. Click the **⁝** icon in the top right corner +2. Select **Settings** +3. Click **About** +4. Find the "Version" information and provide it here: + From 37a6da5a3b2840c7f33631a8ccc66a581fda8e8c Mon Sep 17 00:00:00 2001 From: Robert Ellegate Date: Sun, 9 Apr 2023 11:16:01 -0400 Subject: [PATCH 2/3] =?UTF-8?q?=F0=9F=8E=A8=20style(issue=5Ftemplate):=20a?= =?UTF-8?q?dd=20prefixes=20to=20issue=20titles=20Add=20prefixes=20to=20iss?= =?UTF-8?q?ue=20titles=20to=20improve=20consistency=20and=20make=20it=20ea?= =?UTF-8?q?sier=20to=20identify=20the=20type=20of=20issue.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - `[FEAT]` for feature requests - `[QUESTION]` for questions Also, update the bug report template to move the instructions for finding the app version to a markdown section and remove the placeholder text from the version input field. This makes it clearer and easier to follow the instructions. --- .github/ISSUE_TEMPLATE/bug_report.yaml | 14 ++++++++------ .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/ISSUE_TEMPLATE/question.md | 2 +- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 224c50a1..f594466c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -23,16 +23,18 @@ body: id: expected attributes: label: "Describe what you expected to happen:" + - type: markdown + attributes: + value: | + Please follow these steps to find your app version: + 1. Click the **⁝** icon in the top right corner + 2. Select **Settings** + 3. Click **About** + 4. Find the "Version" information and provide it here - type: input id: version attributes: label: "What version of Keepass2Android are you using?" - placeholder: | - Please follow these steps to find your app version: - 1. Click the **⁝** icon in the top right corner - 2. Select **Settings** - 3. Click **About** - 4. Find the "Version" information and provide it here validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 3b69df7a..fdb2ed38 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,7 +1,7 @@ --- name: Feature Request about: Suggest an idea for this project. -title: '' +title: '[FEAT] ' labels: enhancement assignees: '' diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index b3d154c3..8953e6b7 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,7 +1,7 @@ --- name: Question about: Ask a question about 'Keepass2Android'. -title: '' +title: '[QUESTION] ' labels: question assignees: '' From 746dcd4c6ba0ac1b97c962f8fd0ce5668f1742d4 Mon Sep 17 00:00:00 2001 From: Robert Ellegate Date: Sun, 9 Apr 2023 11:20:44 -0400 Subject: [PATCH 3/3] =?UTF-8?q?=F0=9F=8E=A8=20style(issue=5Ftemplate):=20i?= =?UTF-8?q?mprove=20readability=20of=20bug=20report=20template=20This=20co?= =?UTF-8?q?mmit=20improves=20the=20readability=20of=20the=20bug=20report?= =?UTF-8?q?=20template=20by=20changing=20the=20label=20of=20the=20"Version?= =?UTF-8?q?"=20information=20to=20"provide=20it=20below"=20instead=20of=20?= =?UTF-8?q?"provide=20it=20here".=20Additionally,=20the=20"Which=20version?= =?UTF-8?q?=20of=20Android=20are=20you=20on=3F"=20question=20is=20now=20a?= =?UTF-8?q?=20separate=20input=20field=20instead=20of=20a=20textarea,=20wh?= =?UTF-8?q?ich=20makes=20it=20easier=20to=20answer.=20Finally,=20the=20mar?= =?UTF-8?q?kdown=20formatting=20of=20the=20instructions=20for=20finding=20?= =?UTF-8?q?the=20Android=20version=20is=20improved=20for=20better=20readab?= =?UTF-8?q?ility.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.yaml | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index f594466c..83c2e089 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -30,22 +30,24 @@ body: 1. Click the **⁝** icon in the top right corner 2. Select **Settings** 3. Click **About** - 4. Find the "Version" information and provide it here + 4. Find the "Version" information and provide it below - type: input id: version attributes: label: "What version of Keepass2Android are you using?" validations: required: true - - type: textarea + - type: markdown + attributes: + value: | + Please follow these steps to find your Android version: + 1. Open your device's **Settings** app + 2. Scroll down and select **About phone** or **About tablet** + 3. Find the **Android version** section and provide it below + - type: input id: os attributes: - label: Which version of Android are you on? - placeholder: | - Please follow these steps to find your Android version: - 1. Open your device's **Settings** app. - 2. Scroll down and select **About phone** or **About tablet**. - 3. Find the **Android version** section and provide it here. + label: "Which version of Android are you on?" validations: required: true