From 47279e7eea714c77c1bc806090585fd11fddc73a Mon Sep 17 00:00:00 2001 From: Adison Cavani Date: Mon, 5 Jun 2023 13:10:32 +0200 Subject: [PATCH 1/5] feat: add basic bug report issue template --- .github/ISSUE_TEMPLATE/bug_report.yml | 59 +++++++++++++++++++++++++++ 1 file changed, 59 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 0000000..55bbfd2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,59 @@ +name: 🐞 Bug +description: File a bug/issue +title: "[BUG] " +labels: [Bug, Needs Triage] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false +- type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - **Node**: 13.14.0 + - **npm**: 7.6.3 + value: | + - OS: + - Node: + - npm: + render: markdown + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false \ No newline at end of file From 36b3584fcaae544b16cbb272706d9462f6b37cf0 Mon Sep 17 00:00:00 2001 From: Adison Cavani <adriansrodon@tuta.io> Date: Mon, 5 Jun 2023 13:15:54 +0200 Subject: [PATCH 2/5] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 55bbfd2..3fb2687 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,7 +1,7 @@ name: 🐞 Bug description: File a bug/issue title: "[BUG] <title>" -labels: [Bug, Needs Triage] +labels: [bug] body: - type: checkboxes attributes: @@ -22,29 +22,14 @@ body: description: A concise description of what you expected to happen. validations: required: false -- type: textarea - attributes: - label: Steps To Reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. In this environment... - 2. With this config... - 3. Run '...' - 4. See error... - validations: - required: false - type: textarea attributes: label: Environment description: | examples: - **OS**: Ubuntu 20.04 - - **Node**: 13.14.0 - - **npm**: 7.6.3 value: | - OS: - - Node: - - npm: render: markdown validations: required: false @@ -54,6 +39,6 @@ body: description: | Links? References? Anything that will give us more context about the issue you are encountering! - Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + Tip: You can attach screenshots or log files by clicking this area to highlight it and then dragging files in. validations: required: false \ No newline at end of file From f830e122a8b993378befeca6411e2cbf1ac770dc Mon Sep 17 00:00:00 2001 From: Adison Cavani <adriansrodon@tuta.io> Date: Mon, 5 Jun 2023 13:18:14 +0200 Subject: [PATCH 3/5] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 3fb2687..f6673f4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -28,8 +28,10 @@ body: description: | examples: - **OS**: Ubuntu 20.04 + - **Resolution**: 1920x1080 value: | - - OS: + - OS: + - Resolution: render: markdown validations: required: false From a3222dc3d60e9692f633f41ef969c0244fafbbee Mon Sep 17 00:00:00 2001 From: Adison Cavani <adriansrodon@tuta.io> Date: Mon, 5 Jun 2023 13:18:57 +0200 Subject: [PATCH 4/5] Delete bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 24 ------------------------ 1 file changed, 24 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index bf4f96a..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: AdisonCavani - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. Ubuntu 20.10] - - Resolution [e.g. 1920 x 1080] - -**Additional context** -Add any other context about the problem here. From 2a996e2581baf095fad931c39f2a8910c616b5e2 Mon Sep 17 00:00:00 2001 From: Adison Cavani <adriansrodon@tuta.io> Date: Mon, 5 Jun 2023 13:26:14 +0200 Subject: [PATCH 5/5] Switch to form issue submission (feature-request) --- .github/ISSUE_TEMPLATE/feature_request.md | 23 ------------ .github/ISSUE_TEMPLATE/feature_request.yml | 42 ++++++++++++++++++++++ 2 files changed, 42 insertions(+), 23 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 323c2d7..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: AdisonCavani - ---- - -**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. - -**Contributing** -- [ ] I'm willing to open a pull-request and implement this feature myself diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..a1ea000 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,42 @@ +name: 🐞 Feature request +description: Suggest an idea for this project +title: "[FEAT] <title>" +labels: [feature-request] +body: +- type: textarea + attributes: + label: Is your feature request related to a problem? Please describe + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: false +- type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen + validations: + required: false +- type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered + validations: + required: false +- type: textarea + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here + validations: + required: false +- type: dropdown + attributes: + label: Contributing + multiple: false + options: + - "Yes, I am willing to help implement this feature in a PR" + - "No, I am afraid I cannot help regarding this" + validations: + required: true + - type: markdown + attributes: + value: | + It takes a lot of work and time maintaining this project; any contribution is welcomed \ No newline at end of file