From 2966e5a76784df970f63cb425c50abc706e45a13 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Louf?= <remi@thetypicalset.com>
Date: Tue, 22 Nov 2022 09:53:54 +0100
Subject: [PATCH] Update the issue templates

---
 .github/ISSUE_TEMPLATE/bug_report.md  | 50 -----------------
 .github/ISSUE_TEMPLATE/bug_report.yml | 77 +++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml     |  4 ++
 .github/ISSUE_TEMPLATE/how_to.md      |  9 ----
 4 files changed, 81 insertions(+), 59 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
 delete mode 100644 .github/ISSUE_TEMPLATE/how_to.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 62350014e..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,50 +0,0 @@
----
-name: Bug report
-about: Create a report to help us reproduce and correct the bug.
-title: ''
-labels: ''
-assignees: ''
----
-
-<!--
-Before submitting a bug, please make sure the issue hasn't been already
-addressed by searching through the past issues.
--->
-
-### Bug Description
-
-<!--
-A clear and concise description of what the bug is.
--->
-
-#### Steps/Code to Reproduce
-<!--
-Please add a minimal example that we can reproduce the error by running the
-code. Be as succinct as possible, do not depend on external data. In short, we
-need to be able to copy/paste the code and get the same result as you.
-
-If the code is too long, feel free to put it in a public gist and link
-it in the issue: https://gist.github.com
--->
-
-```python
-Sample code to reproduce the problem
-```
-
-#### Expected Results
-<!-- Please paste or describe the expected results.-->
-
-#### Actual Results
-<!-- Please paste or specifically describe the actual output or traceback. -->
-
-#### Versions
-<!--
-Please run the following snippet and paste the output below.
-import blackjax; print("BlackJAX", blackjax.__version__)
-import sys; print("Python", sys.version)
-import jax; print("Jax", jax.__version__)
-import jaxlib; print("Jaxlib", jaxlib.__version__)
--->
-
-
-<!-- Thanks for contributing! -->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..e95c7143a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,77 @@
+# Issue template inspired by NumPy's excellent template:
+# https://github.com/numpy/numpy/edit/main/.github/ISSUE_TEMPLATE/bug-report.yml
+name: Bug report
+description: Create a bug report to help us reproduce and correct it.
+title: "<Please write a descriptive title>"
+labels: [00 - Bug]
+
+body:
+- type: markdown
+  attributes:
+    value: >
+      Thank you for taking the time to file a bug report. Before creating a new
+      issue, please make sure to take a few minutes to check the issue tracker
+      for open and closed issues that may be related to your bug.
+
+- type: textarea
+  attributes:
+    label: "Describe the issue as clearly as possible:"
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: "Steps/code to reproduce the bug:"
+    description: >
+      A short code example that reproduces the problem/missing feature. It
+      should be self-contained, i.e., can be copy-pasted into the Python
+      interpreter or run as-is via `python myproblem.py`.
+    placeholder: |
+      import blackjax
+      << your code here >>
+    render: python
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: "Expected result:"
+    description: >
+      Please describe what you expect the above example to output.
+    placeholder: |
+      << the expected result here >>
+    render: shell
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: "Error message:"
+    description: >
+      Please include the full error message, if any.
+    placeholder: |
+      << Full traceback starting from `Traceback: ...` >>
+    render: shell
+
+- type: textarea
+  attributes:
+    label: "Blackjax/JAX/jaxlib/Python version information:"
+    description: Please run the following code and paste the output here.
+    placeholder: |
+        import blackjax; print("BlackJAX", blackjax.__version__)
+        import sys; print("Python", sys.version)
+        import jax; print("Jax", jax.__version__)
+        import jaxlib; print("Jaxlib", jaxlib.__version__)
+    render: python
+  validations:
+    required: true
+
+- type: textarea
+  attributes:
+    label: "Context for the issue:"
+    description: |
+      Please explain how this issue affects your work or why it should be prioritized.
+    placeholder: |
+      << your explanation here >>
+  validations:
+    required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..1ce87d9bf
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,4 @@
+contact_links:
+  - name: Question/Help/Support
+    url: https://github.com/blackjax-devs/blackjax/discussions/new
+    about: "If you have a question about how to use Blackjax, please start a discussion."
diff --git a/.github/ISSUE_TEMPLATE/how_to.md b/.github/ISSUE_TEMPLATE/how_to.md
deleted file mode 100644
index 81efc3f38..000000000
--- a/.github/ISSUE_TEMPLATE/how_to.md
+++ /dev/null
@@ -1,9 +0,0 @@
----
-name: How to do X?
-about: You would like to use blackjax but don't know how.
-title: ''
-labels: ''
-assignees: ''
----
-
-Please [open an new discussion](https://github.com/blackjax-devs/blackjax/discussions/new). The issue tracker is reserved for bug reports and feature requests.