Skip to content

Commit

Permalink
chore: replace issue templates with forms (#6982)
Browse files Browse the repository at this point in the history
# 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

<!--

Please select **one** of the following options that describes your
change and delete the others. Clearly identifying the type of change you
are making will help us review your PR faster, and is used in authoring
release notes.

If you are making a bug fix or functionality change to Radius and do not
have an associated issue link please create one now.

-->

- 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).

<!--

Please update the following to link the associated issue. This is
required for some kinds of changes (see above).

-->

Fixes: #6981

## Auto-generated summary

<!--
GitHub Copilot for docs will auto-generate a summary of the PR
-->

copilot:all

---------

Signed-off-by: Christian Lechner <lechnerc77@users.noreply.github.com>
Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>
Co-authored-by: Ryan Nowak <nowakra@gmail.com>
  • Loading branch information
3 people authored Jan 13, 2024
1 parent c0783ff commit 21b25dd
Show file tree
Hide file tree
Showing 6 changed files with 176 additions and 95 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug Report
description: Report broken functionality within Radius
title: "<BUG 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
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/engineering.md

This file was deleted.

71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/engineering.yaml
Original file line number Diff line number Diff line change
@@ -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
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature.md

This file was deleted.

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 21b25dd

Please sign in to comment.