From 02ab2ba84279b4438d71660ff552310f8520a575 Mon Sep 17 00:00:00 2001
From: Neil Vaytet <neil.vaytet@esss.se>
Date: Thu, 22 Feb 2024 10:44:45 +0100
Subject: [PATCH] Apply ess template

---
 .copier-answers.ess.yml                       |  3 +
 .github/ISSUE_TEMPLATE/blank.md               |  8 ++
 .../ISSUE_TEMPLATE/high-level-requirement.yml | 89 +++++++++++++++++++
 3 files changed, 100 insertions(+)
 create mode 100644 .copier-answers.ess.yml
 create mode 100644 .github/ISSUE_TEMPLATE/blank.md
 create mode 100644 .github/ISSUE_TEMPLATE/high-level-requirement.yml

diff --git a/.copier-answers.ess.yml b/.copier-answers.ess.yml
new file mode 100644
index 00000000..1ab77e63
--- /dev/null
+++ b/.copier-answers.ess.yml
@@ -0,0 +1,3 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: 0951a4b
+_src_path: https://github.com/scipp/ess_template.git
diff --git a/.github/ISSUE_TEMPLATE/blank.md b/.github/ISSUE_TEMPLATE/blank.md
new file mode 100644
index 00000000..22a75aeb
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/blank.md
@@ -0,0 +1,8 @@
+---
+name: Blank
+about: General issue that does not fit another category
+title: ''
+labels: ''
+assignees: ''
+
+---
diff --git a/.github/ISSUE_TEMPLATE/high-level-requirement.yml b/.github/ISSUE_TEMPLATE/high-level-requirement.yml
new file mode 100644
index 00000000..cedef1d9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/high-level-requirement.yml
@@ -0,0 +1,89 @@
+name: High-level requirement
+description: Describe a high-level requirement
+title: "[Requirement] "
+labels: ["requirement"]
+projects: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to provide as many details as possible for this requirement!
+  - type: input
+    id: summary
+    attributes:
+      label: Executive summary
+      description: Provide a short summary of the requirement
+      placeholder: "Example: We need to correct for X when processing Y."
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Context and background knowledge
+      description: |
+        - What is the context of this requirement?
+        - What background knowledge is required to understand it?
+        - Does this depend on previous tasks? Provide links!
+        - Is there follow-up work?
+      placeholder: "Example: See summary on Wikipedia, or the following paper."
+    validations:
+      required: true
+  - type: textarea
+    id: inputs
+    attributes:
+      label: Inputs
+      description: |
+        Describe in detail all the input data and data properties that are known.
+        This is not about test data (see below), but about general properties of data that will be used in practice.
+      placeholder: "Example: A single 1-D spectrum with a known wavelength range."
+    validations:
+      required: true
+  - type: textarea
+    id: methodology
+    attributes:
+      label: Methodology
+      description: |
+        Describe, e.g., the computation to be performed.
+        When linking to references, please refer to the specific section, page, or equation.
+      placeholder: "Remember you can write equations such as $n\\lambda = 2d\\sin(\\theta)$ using LaTeX syntax, as well as other Markdown formatting."
+    validations:
+      required: true
+  - type: textarea
+    id: outputs
+    attributes:
+      label: Outputs
+      description: |
+        Describe in detail all the output data and data properties.
+        This is not about test data (see below), but about general properties of data that will be used in practice.
+      placeholder: "Example: The position of the peak in the spectrum."
+    validations:
+      required: true
+  - type: dropdown
+    id: interfaces
+    attributes:
+      label: Which interfaces are required?
+      multiple: true
+      options:
+        - Integrated into reduction workflow
+        - Python module / function
+        - Python script
+        - Jupyter notebook
+        - Other (please describe in comments)
+      default: 0
+    validations:
+      required: true
+  - type: textarea
+    id: testcases
+    attributes:
+      label: Test cases
+      description: How can we test this requirement? Links to tests data and reference data, or other suggestions.
+    validations:
+      required: true
+  - type: textarea
+    id: comments
+    attributes:
+      label: Comments
+      description: Do you have other comments that do not fall in the above categories?
+      placeholder: "Example: Depends on issues #1234, blocked by #666."
+    validations:
+      required: false