diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5feebd30..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,31 +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. - -**Environment (please complete the following information):** - - OS: [e.g. Windows] - - SDK Version [e.g. 1.0] - -**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 00000000..51c70eaa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,87 @@ +name: Bug report +description: Something is not working correctly. +labels: "S: needs triage, type: bug" + +body: + - type: markdown + attributes: + value: >- + Hi there! + + We'd appreciate it if you could search on existing issues prior to filing + a bug report. + + We get a lot of duplicate tickets and have limited maintainer capacity to triage + them. Thanks! + + - type: textarea + attributes: + label: Description + description: >- + A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + attributes: + label: Expected behavior + description: >- + A clear and concise description of what you expected to happen. + + - type: input + attributes: + label: SDK Version + description: e.g., 1.0.0 + validations: + required: true + + - type: input + attributes: + label: Python Version + description: e.g., Python 3.10, Python 3.11, Python 3.12 + validations: + required: true + + - type: input + attributes: + label: OS + description: e.g., Windows 11, macOS 14, Ubuntu 22.04 + validations: + required: true + + - type: textarea + attributes: + label: How to Reproduce + description: Please provide steps to reproduce this bug. + placeholder: | + 1. Go to '...' + 2. Run '...' + 3. An error occurs. + validations: + required: true + + - type: textarea + attributes: + label: Output + description: >- + Provide the output of the steps above, including the commands + themselves and any error messages/traceback. + + If you want to present output from multiple commands, please prefix + the line containing the command with $ . Please also ensure that + the "How to reproduce" section contains matching instructions for + reproducing this. + + - type: textarea + attributes: + label: Screenshots + description: >- + If applicable, add screenshots to help explain your problem. + + - type: checkboxes + attributes: + label: Code of Conduct + options: + - label: >- + I agree to follow the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f86a5749..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,26 +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 is. Ex. When I try X [...] - -**Priority you would assign to the feature** -Choose between High, Medium, Low. - -**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. - -**Available workarounds** -Are there any available workarounds in case this feature does not get picked up? - -**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 00000000..ce79de17 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,66 @@ +name: Feature request +description: Suggest an idea for this project. +labels: "S: needs triage, type: feature" + +body: + - type: markdown + attributes: + value: >- + Hi there! + + Thanks for taking the time to suggest a new feature! Please search existing + issues first to make sure this hasn't already been requested. + + - type: textarea + attributes: + label: Is your feature request related to a problem? + description: >- + A clear and concise description of what the problem is. + placeholder: "Ex. When I try X [...]" + validations: + required: true + + - type: dropdown + attributes: + label: Priority + description: What priority would you assign to this feature? + options: + - High + - Medium + - Low + validations: + required: true + + - type: textarea + attributes: + label: Describe the solution you'd like + description: >- + A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + attributes: + label: Describe alternatives you've considered + description: >- + A clear and concise description of any alternative solutions or features you've considered. + + - type: textarea + attributes: + label: Available workarounds + description: >- + Are there any available workarounds in case this feature does not get picked up? + + - type: textarea + attributes: + label: Additional context + description: >- + Add any other context or screenshots about the feature request here. + + - type: checkboxes + attributes: + label: Code of Conduct + options: + - label: >- + I agree to follow the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). + required: true