From f588cdee540a926108236230114026f8d1ba5018 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mickae=CC=88l=20Menu?= <mickael.menu@gmail.com>
Date: Tue, 9 Jan 2024 10:27:27 +0100
Subject: [PATCH] Add a new form-based bug report issue template

---
 .github/ISSUE_TEMPLATE/bug_report.md  | 75 -----------------------
 .github/ISSUE_TEMPLATE/bug_report.yml | 85 +++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml     |  1 +
 3 files changed, 86 insertions(+), 75 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 70b4ed7fa..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,75 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-## Bug Report
-
-<!--
-IMPORTANT: Your issue might be closed if we are not able to reproduce the problem. Please take the time to describe how to reproduce it and give as much details as possible. The more effort you put in, the more chance of finding a solution.
--->
-
-### What happened?
-
-<!--
-A clear and concise description of what the bug is.
-
-If you can, drag and drop screenshots or a screencast to show the problem, they are super helpful to avoid misunderstandings.
--->
-
-### Expected behavior
-
-<!-- Tell us what you think should happen. -->
-
-### How to reproduce?
-
-<!--
-If you can, drag and drop the publication used to reproduce the problem, after zipping it.
-
-Then, explain the steps to reproduce the problem from the Test App (https://github.com/readium/r2-testapp-swift). For example:
-
-1. Open book X
-2. Go to chapter Y
-3. Click on link Z
-4. See error
--->
-
-### Environment
-
-<!-- Fill in the following information -->
-
-* Readium version: 
-
-#### Development environment
-
-<!--
-Paste the output of these commands:
-
-echo "macOS: `sw_vers -productVersion`"
-echo "platform: `uname -m`"
-echo "carthage: `carthage version`"
-xcodebuild -version
-
--->
-
-#### Testing device
-
-* iOS version:
-* Model (e.g. iPhone 11 Pro Max): 
-* Is it an emulator? Yes or No
-
-### Additional context
-
-* Are you willing to fix the problem and contribute a pull request? Yes or No <!-- Help can be provided to guide you through the project -->
-
-<!--
-Share additional code showing how you use Readium, if relevant.
-
-Output logs are useful as well.
-
-If you already went through the codebase to find the bug, you can explain your findings here.
--->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..cbe63e51c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,85 @@
+name: Bug report
+description: File a bug report to help improve the Readium toolkit
+title: "[Bug] "
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for filing a bug report! Please [search for existing issues](https://github.com/readium/swift-toolkit/issues?q=is:issue) before submitting.
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the bug
+      description: Also, please let us know what your expectations were.
+      placeholder: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: bug-steps
+    attributes:
+      label: How to reproduce?
+      description: |
+        Step by step explanation to reproduce the issue in the Test App.
+
+        If you can, drag and drop:
+        - the publication used to reproduce the problem, after zipping it.
+        - screenshots or a screencast showing the issue
+
+      placeholder: |
+        1. Open book X
+        2. Go to chapter Y
+        3. Swipe left twice
+        4. See error
+        ...
+    validations:
+      required: true
+  - type: input
+    id: bug-readium-version
+    attributes:
+      label: Readium version
+      description: What version of the Readium toolkit are you running?
+    validations:
+      required: true
+  - type: input
+    id: bug-os-version
+    attributes:
+      label: OS version
+      description: On which OS version(s) did you reproduce the problem?
+      placeholder: iOS 17.0.1
+    validations:
+      required: true
+  - type: input
+    id: bug-device
+    attributes:
+      label: Testing device
+      description: On which Apple device did you reproduce the problem?
+      placeholder: iPhone 15 Pro Max (emulator)
+    validations:
+      required: true
+  - type: textarea
+    id: bug-environment
+    attributes:
+      label: Environment
+      description: |
+        Run the following shell commands and paste the result here:
+        ```shell
+        echo "macOS: `sw_vers -productVersion`"
+        echo "platform: `uname -m`"
+        echo "carthage: `carthage version`"
+        xcodebuild -version
+        ```
+      placeholder: |
+        macOS: 14.1.2
+        platform: arm64
+        carthage: 0.39.1
+        Xcode 15.1
+        Build version 15C65
+      render: bash
+  - type: textarea
+    id: bug-additional
+    attributes:
+      label: Additional context
+      description: |
+        Share additional code showing how you use Readium, if relevant. Output logs are useful as well.
+        If you already went through the codebase to find the bug, you can explain your findings here.
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..ec4bb386b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
\ No newline at end of file