Add issue templates for question, bug, and feature request (Azure#27610)

* Add issue templates for question, bug, and feature request * Added labels to bug and feature request templates * Update .github/ISSUE_TEMPLATE/01_question.yml Co-authored-by: Konrad Jamrozik <[email protected]> * Update .github/ISSUE_TEMPLATE/01_question.yml Co-authored-by: Konrad Jamrozik <[email protected]> * Updates to the Spec and Version inputs --------- Co-authored-by: Konrad Jamrozik <[email protected]>
nasc17 · Feb 7, 2024 · bd36f7f · bd36f7f
1 parent ef87932
commit bd36f7f
Show file tree

Hide file tree

Showing 3 changed files with 156 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/01_question.yml b/.github/ISSUE_TEMPLATE/01_question.yml
@@ -0,0 +1,46 @@
+name: Question/Query
+description: Use this template to file a question/query for the API Spec team that are not bugs or feature requests.
+title: "[Question]"
+
+labels:
+  - question
+
+body:
+  - type: input
+    id: api_spec
+    attributes:
+      label: API Spec link
+      description: "Link to the OpenAPI or TypeSpec spec"
+      placeholder: "e.g. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/containerservice/Fleet.Management/main.tsp"
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: API Spec version
+      description: "Version of the API Spec"
+      placeholder: "e.g. 2023-10-15"
+    validations:
+      required: true
+
+  - type: textarea
+    id: background
+    attributes:
+      label: Question/Query
+      description: How can we help?
+      placeholder: Description
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: |
+        Please provide more information on your environment:
+          * Hosting platform or OS and .NET runtime version (`dotnet --info` output for .NET Core projects): [e.g. Azure AppService or Windows 10 .NET Framework 4.8]
+          * IDE and version: [e.g. Visual Studio 16.3]
+      placeholder: Environment
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/02_bug.yml b/.github/ISSUE_TEMPLATE/02_bug.yml
@@ -0,0 +1,76 @@
+name: Bug report
+description: Use this template to file a bug on an API Spec.
+title: "[BUG]"
+
+labels:
+  - bug
+
+body:
+  - type: input
+    id: api_spec
+    attributes:
+      label: API Spec link
+      description: "Link to the OpenAPI or TypeSpec spec"
+      placeholder: "e.g. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/containerservice/Fleet.Management/main.tsp"
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: API Spec version
+      description: "Version of the API Spec"
+      placeholder: "e.g. 2023-10-15"
+    validations:
+      required: true
+
+  - type: textarea
+    id: background
+    attributes:
+      label: Describe the bug
+      description: Please provide the description of issue you're seeing.
+      placeholder: Description
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: |
+        Provide a description of the expected behavior.
+      placeholder: Expected behavior
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-behavior
+    attributes:
+      label: Actual behavior
+      description: |
+        Provide a description of the actual behavior observed. If applicable please include any error messages, exception stacktraces or memory dumps.
+      placeholder: Actual behavior
+    validations:
+      required: true
+
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: Reproduction Steps
+      description: |
+        Please include minimal steps to reproduce the problem if possible. E.g.: the smallest possible code snippet; or a small project, with steps to run it. If possible include text as text rather than screenshots (so it shows up in searches).
+      placeholder: Minimal Reproduction
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: |
+        Please provide more information on your environment:
+          * Hosting platform or OS and .NET runtime version (`dotnet --info` output for .NET Core projects): [e.g. Azure AppService or Windows 10 .NET Framework 4.8]
+          * IDE and version : [e.g. Visual Studio 16.3]
+      placeholder: Environment
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/03_feature_request.yml b/.github/ISSUE_TEMPLATE/03_feature_request.yml
@@ -0,0 +1,34 @@
+name: Feature request
+description: Use this template to file a feature request on an API Spec.
+title: "[FEATURE REQ]"
+
+labels:
+  - feature-request
+
+body:
+  - type: input
+    id: api_spec
+    attributes:
+      label: API Spec link
+      description: "Link to the OpenAPI or TypeSpec spec"
+      placeholder: "e.g. https://github.com/Azure/azure-rest-api-specs/blob/main/specification/containerservice/Fleet.Management/main.tsp"
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: API Spec version
+      description: "Version of the API Spec"
+      placeholder: "e.g. 2023-10-15"
+    validations:
+      required: true
+
+  - type: textarea
+    id: background
+    attributes:
+      label: Please describe the feature.
+      description: What feature would you like to get added? What problem is it solving?
+      placeholder: Feature description
+    validations:
+      required: true