From 21b25ddf265f0464e4641b8c79cff61a4f9badd0 Mon Sep 17 00:00:00 2001 From: Christian Lechner Date: Sat, 13 Jan 2024 18:53:53 +0100 Subject: [PATCH] chore: replace issue templates with forms (#6982) # Description This PR contains a proposal for the migration of the issue templates from markdown to form-based to improve the usability for reporters. For details and screenshots of the layout, please check issue #6981 ## Type of change - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional). Fixes: #6981 ## Auto-generated summary copilot:all --------- Signed-off-by: Christian Lechner Co-authored-by: Aaron Crawfis Co-authored-by: Ryan Nowak --- .github/ISSUE_TEMPLATE/bug.md | 38 ------------- .github/ISSUE_TEMPLATE/bug.yaml | 71 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/engineering.md | 38 ------------- .github/ISSUE_TEMPLATE/engineering.yaml | 71 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature.md | 19 ------- .github/ISSUE_TEMPLATE/feature.yaml | 34 ++++++++++++ 6 files changed, 176 insertions(+), 95 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml delete mode 100644 .github/ISSUE_TEMPLATE/engineering.md create mode 100644 .github/ISSUE_TEMPLATE/engineering.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/feature.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 3669772196..0000000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug Report -about: Report broken functionality within Radius -title: "" -assignees: '' -labels: ["bug"] ---- - -## Bug information - -### Steps to reproduce (required) - - -### Observed behavior (required) - - - - -### Desired behavior (required) - - -### Workaround (optional) - - -## System information - -### rad Version (required) - - - - -### Operating system (required) - - - - -## Additional context - diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 0000000000..f2a853f689 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -0,0 +1,71 @@ +name: Bug Report +description: Report broken functionality within Radius +title: "" +labels: ["bug"] +body: + - type: markdown + attributes: + value: "## Bug information" + - type: textarea + attributes: + label: Steps to reproduce + description: How can we recreate this bug? Be specific. + validations: + required: true + - type: textarea + attributes: + label: Observed behavior + description: What you're experiencing that you believe is a bug. + placeholder: | + If applicable, add screenshots to help explain your problem. + + Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: textarea + attributes: + label: Desired behavior + description: What you're expecting to happen. + validations: + required: true + - type: textarea + attributes: + label: Workaround + description: Have you found a workaround to get you unblocked? + validations: + required: false + - type: markdown + attributes: + value: "## System information" + - type: textarea + attributes: + label: rad Version + description: What rad cli version are you running? + placeholder: PASTE OUTPUT OF "rad version" + validations: + required: true + - type: textarea + attributes: + label: Operating system + description: What operating system (macOS Monterey, Windows 11, etc.) and architecture (x86, x64, arm64, etc.) are you running? + placeholder: | + For example: macOS Monterey, M1 chip + validations: + required: false + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + placeholder: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: checkboxes + attributes: + label: Would you like to support us? + description: Would you like to support us in fixing this bug? + options: + - label: Yes, I would like to support you + required: false diff --git a/.github/ISSUE_TEMPLATE/engineering.md b/.github/ISSUE_TEMPLATE/engineering.md deleted file mode 100644 index a6407fce9a..0000000000 --- a/.github/ISSUE_TEMPLATE/engineering.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Engineering Improvement -about: Report problems or suggestions to improve the Radius engineering processes and/or pipelines -title: "" -assignees: '' -labels: ["maintenance"] ---- - -## Engineering Improvement - -### Area for Improvement (required) -<!--What engineering process or tools can be improved? Build? Testing? ...? Be specific--> - -### Observed behavior (required) -<!--What you're experiencing that you believe could be improved--> - -<!--If applicable, add screenshots to help explain your problem--> - -### Desired behavior (required) -<!--What you'd like to happen--> - -### Proposed Fix (optional) -<!--Have you found a way to implement or fix the issue?--> - -## System information - -### rad Version (required) -<!--What rad cli version are you running?--> - -<!-- PASTE OUTPUT OF `rad version` --> - -### Operating system (required) -<!--What operating system (macOS Monterey, Windows 11, etc.) and architecture (x86, x64, arm64, etc.) are you running?--> - -<!-- For example: macOS Monterey, M1 chip --> - -## Additional context -<!--Add any other context about the problem here--> \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/engineering.yaml b/.github/ISSUE_TEMPLATE/engineering.yaml new file mode 100644 index 0000000000..11c207b881 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/engineering.yaml @@ -0,0 +1,71 @@ +name: Engineering Improvement +description: Report problems or suggestions to improve the Radius engineering processes and/or pipelines +title: "<TITLE>" +labels: ["maintenance"] +body: + - type: markdown + attributes: + value: "## Engineering Improvement" + - type: textarea + attributes: + label: Area for Improvement + description: What engineering process or tools can be improved? Build? Testing? ...? Be specific. + validations: + required: true + - type: textarea + attributes: + label: Observed behavior + description: What you're experiencing that you believe could be improved. + placeholder: | + If applicable, add screenshots to help explain your problem. + + Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: textarea + attributes: + label: Desired behavior + description: What you'd like to happen. + validations: + required: true + - type: textarea + attributes: + label: Proposed Fix + description: Have you found a way to implement or fix the issue? + validations: + required: false + - type: markdown + attributes: + value: "## System information" + - type: textarea + attributes: + label: rad Version + description: What rad cli version are you running? + placeholder: PASTE OUTPUT OF "rad version" + validations: + required: true + - type: textarea + attributes: + label: Operating system + description: What operating system (macOS Monterey, Windows 11, etc.) and architecture (x86, x64, arm64, etc.) are you running? + placeholder: | + For example: macOS Monterey, M1 chip + validations: + required: false + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here + placeholder: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: checkboxes + attributes: + label: Would you like to support us? + description: Would you like to support us in improving Radius engineering processes and/or pipelines? + options: + - label: Yes, I would like to support you + required: false diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index 081a128a52..0000000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature Request -about: Request a feature in Radius -title: "<FEATURE TITLE>" -assignees: '' -labels: ["feature"] ---- - -## Overview of feature request - -<!--What are you proposing Radius add/update/remove?--> - -## Acceptance criteria - -<!--What will need to be completed/working for this feature to be marked "Done"--> - -## Additional context - -<!--Add any other context about the problem here--> \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 0000000000..e00fd52732 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -0,0 +1,34 @@ +name: Feature Request +description: Request a feature in Radius +title: "<FEATURE TITLE>" +labels: ["feature"] +body: + - type: textarea + attributes: + label: Overview of feature request + description: What are you proposing Radius add/update/remove? + validations: + required: true + - type: textarea + attributes: + label: Acceptance criteria + description: What will need to be completed/working for this feature to be marked "Done"? + validations: + required: false + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here + placeholder: | + Links? References? Anything that will give us more context about the feature you are looking for! + + Tip: You can attach images or files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: checkboxes + attributes: + label: Would you like to support us? + description: Would you like to support us in implementing the feature? + options: + - label: Yes, I would like to support you + required: false