From 00121774f5ccd7337d7b51f2e2c38584cb6a7685 Mon Sep 17 00:00:00 2001
From: Xiaowei Zhu <33129495+zhu-xiaowei@users.noreply.github.com>
Date: Fri, 19 May 2023 18:20:26 +0800
Subject: [PATCH] feat: add issue and pr template (#4)

Co-authored-by: xiaoweii <xiaoweii@amazom.com>
---
 .github/ISSUE_TEMPLATE/bug_report.yaml      | 110 ++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.yaml |  32 ++++++
 .github/PULL_REQUEST_TEMPLATE.md            |  18 ++++
 3 files changed, 160 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
new file mode 100644
index 0000000..82ac39e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,110 @@
+name: Bug Report
+description: Create a report to help us improve
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: repro
+    attributes:
+      label: Steps To Reproduce
+      description: How do you trigger this bug? Please walk us through it step by step.
+      value: |
+        Steps to reproduce the behavior:
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+      render: swift
+    validations:
+      required: true
+  - type: textarea
+    id: behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: input
+    id: clickstream-version
+    attributes:
+      label: Clickstream-Swift Version
+      placeholder: e.g. 1.0.0
+    validations:
+      required: true
+  - type: input
+    id: swift
+    attributes:
+      label: Swift version
+      placeholder: e.g. 5.0
+    validations:
+      required: true
+  - type: input
+    id: xcode
+    attributes:
+      label: Xcode version
+      placeholder: |
+        - e.g. 12.4 (12D4e)
+        - Run `xcodebuild -version`
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: >-
+        Include any relevant log output
+      value: |
+        <details>
+        <summary>Log Messages</summary>
+
+        ```
+        INSERT LOG MESSAGES HERE
+        ```
+        </details>
+      render: shell
+  - type: dropdown
+    id: regression
+    attributes:
+      label: Is this a regression?
+      multiple: false
+      options:
+        - "Yes"
+        - "No"
+    validations:
+      required: true
+  - type: textarea
+    id: regression-info
+    attributes:
+      label: Regression additional context
+      placeholder: If it was a regression provide the versions used before and after the upgrade.
+    
+  - type: input
+    id: device
+    attributes:
+      label: Device
+      placeholder: |
+        - e.g. iPhone6
+        - Simulator
+    validations:
+      required: true
+  - type: input
+    id: ios-version
+    attributes:
+      label: iOS Version
+      placeholder: e.g. iOS 11
+    validations:
+      required: true
+  - type: input
+    id: simulators
+    attributes:
+      label: Specific to simulators
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
new file mode 100644
index 0000000..36105ac
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -0,0 +1,32 @@
+name: Feature request
+description: Suggest an idea for this project
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+    validations:
+      required: true
+  
+  - type: textarea
+    id: proposal
+    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
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..c08a7eb
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,18 @@
+## Issue \#
+<!-- If applicable, please link to issue(s) this change addresses -->
+
+## Description
+<!-- Why is this change required? What problem does it solve? -->
+
+## General Checklist
+<!-- Check or cross out if not relevant -->
+
+- [ ] Added new tests to cover change, if needed
+- [ ] Build succeeds using Swift Package Manager
+- [ ] All unit tests pass
+- [ ] Security oriented best practices and standards are followed (e.g. using input sanitization, principle of least privilege, etc)
+- [ ] Documentation update for the change if required
+- [ ] PR title conforms to conventional commit style
+- [ ] If breaking change, documentation/changelog update with migration instructions
+
+By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.