Update issue templates with forms. (#117)

* Create bug.yml * add forms for feature requests and general issues * add correct labels for forms * Update bug.yml * Update feature.yml * Update issue.yml * Update issue.yml Co-authored-by: bogdansurdu <[email protected]> Co-authored-by: George-Bogdan Surdu <[email protected]>
synthesized-io · Sep 15, 2021 · 429ff80 · 429ff80
1 parent a28d095
commit 429ff80
Show file tree

Hide file tree

Showing 3 changed files with 156 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -0,0 +1,61 @@
+---
+name: 🐞 Bug
+description: File a bug/issue
+title: "[BUG] <title>"
+labels: "bug,status:triage"
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Describe the bug
+    description: A concise description of what you're experiencing.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: A concise description of what you expected to happen.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: Steps to reproduce the behavior.
+    placeholder: |
+      ```pycon
+      >>> import fairlens as fl
+      >>> import pandas as pd
+      >>> df = pd.read_csv(...)
+      ...
+      ```
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      examples:
+        - **OS**: Ubuntu 20.04
+        - **python**: 3.7.10
+    value: |
+        - OS:
+        - python:
+    render: markdown
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Anything else? Screenshots?
+    description: |
+      Links? References? Anything that will give us more context about the issue you are encountering!
+
+      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.yml b/.github/ISSUE_TEMPLATE/feature.yml
@@ -0,0 +1,41 @@
+---
+name: Feature Request
+description: Propose a new feature for development
+title: "[FEATURE] <title>"
+labels: "status:triage"
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the feature you want to request or a similar one.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Is your feature request related to a problem?
+    description: A clear and concise description of what the problem or possible improvement is.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Describe the solution you would like
+    description: A clear and concise description of what you want to happen or to be implemented.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Describe alternatives you have considered
+    description: A clear and concise description of any alternative solutions or implementations you've considered.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Additional context
+    description: |
+      Links? References? Anything that could give us more context about the feature you want added!
+
+      Tip: You can attach images by clicking this area to highlight it and then dragging files in.
+  validations:
+    required: false
+...
diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml
@@ -0,0 +1,54 @@
+---
+name: General Issue
+description: Raise a general issue for the project
+title: "[ISSUE] <title>"
+labels: "status:triage"
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists that is similar or describes your own.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: dropdown
+  attributes:
+    label: Issue Type
+    description: How would you best classify the scope of this issue, using the categories below?
+    multiple: true
+    options:
+      - Bug
+      - CI/CD
+      - Documentation
+      - Improvement
+      - Feature
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe the issue
+    description: A clear and concise description of what the issue is.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Describe a solution you would like
+    description: A clear and concise description of the changes you would require for the issue to be resolved.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Describe alternatives you have considered
+    description: A clear and concise description of any alternative solutions or steps that can resolve the issue.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Additional context
+    description: |
+      Links? References? Anything that could give us more context about the issue you have raised and that might help us resolve it!
+
+      Tip: You can attach images by clicking this area to highlight it and then dragging files in.
+  validations:
+    required: false
+...