From a9523e7b141edb3d80a107fad645535b127412ab Mon Sep 17 00:00:00 2001 From: Maarten Tegelaers Date: Mon, 8 Jul 2024 04:58:40 -0400 Subject: [PATCH] chore(issue-template): rewrite to templates to yml renderer (#456) --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ----------- .github/ISSUE_TEMPLATE/bug_report.yml | 62 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ------- .github/ISSUE_TEMPLATE/feature_request.yml | 40 ++++++++++++++ .github/ISSUE_TEMPLATE/task.md | 17 ------ .github/ISSUE_TEMPLATE/task.yml | 29 ++++++++++ 6 files changed, 131 insertions(+), 69 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/task.md create mode 100644 .github/ISSUE_TEMPLATE/task.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 298be751e..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Version info (please complete the following information):** - - OS: [e.g. Windows] - - Version [e.g. 0.1.5] - - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..7667cd84d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,62 @@ +name: Bug Report +description: Create a report to help us improve +title: "[Bug]: " +labels: ["bug", "triage"] +assignees: + - arthurvd +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: bug-description + attributes: + label: Describe the bug + placeholder: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduction-steps + attributes: + label: Reproduction steps + placeholder: | + Steps to reproduce the behavior: + 1. Go to '...' + 2. Click on '...' + 3. Scroll down to '...' + 4. See error + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Reproduction steps + placeholder: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + placeholder: If applicable, add screenshots to help explain your problem. + Tip: You can attach images by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: textarea + id: version-info + attributes: + label: Version info (please complete the following information) + value: | + - OS: [e.g. Windows] + - Version [e.g. 0.1.5] + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context + placeholder: Add any other context or screenshots about the bug report here. + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index a67044115..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -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 or missing functionality is. - -**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 (if applicable). - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..83cf5c430 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,40 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[Feat]: " +labels: ["enhancement", "triage"] +assignees: + - arthurvd +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: textarea + id: existing-problem + attributes: + label: Is your feature request related to a problem? Please describe + placeholder: A clear and concise description of what the problem or missing functionality is. + validations: + required: true + - type: textarea + id: ideal-solution + attributes: + label: Describe the solution you'd like to see + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternative-solutions + attributes: + label: Describe the alternatives you've considered + placeholder: A clear and concise description of any alternative solutions or features you've considered (if applicable). + validations: + required: false + - type: textarea + id: additional-context + attributes: + label: Additional context + placeholder: Add any other context or screenshots about the feature request here. + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md deleted file mode 100644 index fd65144d4..000000000 --- a/.github/ISSUE_TEMPLATE/task.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Task -about: Describe a piece of work (typically non-coding) that should be done. -title: '' -labels: '' -assignees: '' - ---- - -**What is the need for this task.** -Why should this work be done? - -**What is the task?** -A clear and concise description of what you want to happen. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 000000000..9d95fd955 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -0,0 +1,29 @@ +name: Task +description: Describe a piece of work (typically non-coding) that should be done. +title: "[Task]: " +labels: ["chore", "triage"] +assignees: + - arthurvd +body: + - type: textarea + id: what-is-the-need + attributes: + label: What is the need for this task? + placeholder: Why should this work be done + validations: + required: true + - type: textarea + id: what-is-the-task + attributes: + label: What is the task? + placeholder: A clear and concise description of what you want to be done. + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context + placeholder: Add any other context or screenshots about the task here. + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false