From a8e9ada85d6f16fac15e1af86df2856bb47ad3f4 Mon Sep 17 00:00:00 2001
From: Attila Klenik <a.klenik@gmail.com>
Date: Tue, 4 Jan 2022 15:31:29 +0100
Subject: [PATCH] Add GitHub web forms-based issue templates (#1189)

* Add issue template for bug reports
* Add issue template for feature requests
* Still allow the old issue template for now
* Provide links to other Caliper forums

Signed-off-by: Attila Klenik <a.klenik@gmail.com>
---
 .github/ISSUE_TEMPLATE/bug-report.yml      | 88 ++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml          |  8 ++
 .github/ISSUE_TEMPLATE/feature-request.yml | 31 ++++++++
 3 files changed, 127 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml

diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
new file mode 100644
index 000000000..e3d440e33
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,88 @@
+name: Bug Report
+description: File a bug report
+body:
+  - type: markdown
+    attributes:
+        value: Thank you for helping us make Caliper better by submitting a bug report!
+  - type: markdown
+    attributes:
+        value: "## Environment information"
+  - type: input
+    id: caliper_version
+    attributes:
+      label: Which Caliper version are you using?
+      placeholder: "For example: v0.4.2, or latest"
+    validations:
+      required: true
+  - type: input
+    id: nodejs_version
+    attributes:
+      label: Which Node.JS version are you using?
+      placeholder: "For example: v10"
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: Which operating system are you using?
+      placeholder: "For example: Ubuntu 20.04 LTS"
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+        value: "## Behavior information"
+  - type: textarea
+    id: context
+    attributes:
+      label: Please provide some context for your error. For example, when did the error occur? What were you trying to achieve, and how?
+      placeholder: "For example: I tried to monitor remote Docker containers..."
+    validations:
+      required: true
+  - type: textarea
+    id: actual_behavior
+    attributes:
+      label: What was the observed incorrect behavior?
+      placeholder: "For example: Caliper hangs and waits for submitted transactions indefinitely."
+    validations:
+      required: true
+  - type: textarea
+    id: error_log
+    attributes:
+      label: Please provide the error logs and their surroundings.
+      placeholder: "Error logs"
+      render: text
+    validations:
+      required: true
+  - type: textarea
+    id: bench_config
+    attributes:
+      label: Please provide your benchmark configuration file content, if possible.
+      placeholder: "test: ..."
+      render: yaml
+    validations:
+      required: false
+  - type: textarea
+    id: network_config
+    attributes:
+      label: Please provide your network configuration file content, if possible.
+      placeholder: "name: Fabric ..."
+      render: yaml
+    validations:
+      required: false
+  - type: textarea
+    id: workload
+    attributes:
+      label: Please provide your workload module content, if possible.
+      placeholder: "JS file content"
+      render: nodejs
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+        value: "## Additional information"
+  - type: textarea
+    id: additional
+    attributes:
+      label: Please provide any additional information you deem relevant to the error.
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..ca3f13148
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Hyperledger Caliper Rocket.Chat channel
+    url: https://chat.hyperledger.org/channel/caliper
+    about: Please ask general questions about the project here (LFID required).
+  - name: Hyperledger Caliper mailing list
+    url: https://lists.hyperledger.org/g/caliper
+    about: Please ask general questions about the project here (LFID recommended).
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
new file mode 100644
index 000000000..17a121eee
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,31 @@
+name: Feature Request
+description: Request a new Caliper feature
+labels: [enhancement]
+body:
+  - type: markdown
+    attributes:
+        value: Thank you for sharing your ideas about how to improve Caliper!
+  - type: textarea
+    id: limitation
+    attributes:
+      label: Please share the technical limitation of Caliper that you encountered.
+    validations:
+      required: true
+  - type: textarea
+    id: feature
+    attributes:
+      label: Please detail your feature idea that could alleviate the limitation.
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Please share some details about your use case if possible, and how the new feature would make Caliper a better performance benchmarking framework.
+    validations:
+      required: false
+  - type: textarea
+    id: suggestions
+    attributes:
+      label: Please share any suggestions about the new feature's code/configuration API (using formatted YAML segments or pseudo-code).
+    validations:
+      required: false
\ No newline at end of file