From 3161ee53c5816b5c64a1c92e5bbdbaa1dfdf0700 Mon Sep 17 00:00:00 2001 From: Peter Czuczor <61667986+czp13@users.noreply.github.com> Date: Thu, 18 Jan 2024 16:28:56 +0100 Subject: [PATCH 1/4] Update issue templates Update issue templates based on GitHub suggestions and what we use in other projects. --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f96a7e5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: '' +assignees: '' + +--- + +Please provide as many details as possible; this will help us deliver a fix as soon as possible. +Thank you! + +### Description of the Bug + +A short, concise description of the bug and why you consider it a bug. Any details like exceptions and logs can be helpful as well. + +### Expected Behavior + +A description of what you would expect to happen. (Sometimes it is clear what the expected outcome is if something does not work; other times, it is not super clear.) + +### Minimal Reproducible Example + +We would appreciate the minimum code with which we can reproduce the issue. + +### Versions + +- Vaadin Flow/Hilla Framework Version: e.g., 24.3.2 +- Copilot Version: Mention the version number of Copilot. +- Browser Information: e.g., Chrome 96.0.4664.110 +- Additional Information: (Is there anything else you can add about the proposal?) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From daa295a650b17d17d63462864f54adfdd676bc3b Mon Sep 17 00:00:00 2001 From: Peter Czuczor <61667986+czp13@users.noreply.github.com> Date: Thu, 18 Jan 2024 16:29:47 +0100 Subject: [PATCH 2/4] Update .github/ISSUE_TEMPLATE/feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..e0c0168 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: "[FEATURE]" labels: '' assignees: '' From 45e7e5a4e9ef3a324fe7f09cc26730441ffd4c20 Mon Sep 17 00:00:00 2001 From: Peter Czuczor <61667986+czp13@users.noreply.github.com> Date: Thu, 18 Jan 2024 16:35:42 +0100 Subject: [PATCH 3/4] Update feature_request.md Some small changes in the Feature issue template to be more inline with the Bug issue template. --- .github/ISSUE_TEMPLATE/feature_request.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e0c0168..7b5c680 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,16 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** + + +### Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -**Describe the solution you'd like** +### Describe the solution you'd like A clear and concise description of what you want to happen. -**Describe alternatives you've considered** +### Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered. -**Additional context** +### Additional context Add any other context or screenshots about the feature request here. From 8fc6beb55c509247ba081d8ae937d4942ee9ca63 Mon Sep 17 00:00:00 2001 From: Peter Czuczor <61667986+czp13@users.noreply.github.com> Date: Thu, 18 Jan 2024 16:37:23 +0100 Subject: [PATCH 4/4] Update feature_request.md A bit more update to be more precise and synch with the other issue type. --- .github/ISSUE_TEMPLATE/feature_request.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 7b5c680..c99faa5 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -9,14 +9,18 @@ assignees: '' -### Is your feature request related to a problem? Please describe. +### Is your feature request related to a problem? + A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] ### Describe the solution you'd like + A clear and concise description of what you want to happen. ### Describe alternatives you've considered + A clear and concise description of any alternative solutions or features you've considered. ### Additional context -Add any other context or screenshots about the feature request here. + +Add any other context or screenshots, logs, videos about the feature request here.