From 83395e9cdbc3e2b3927b4e2d9a7b66b4def40695 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= <deamarialeon@gmail.com>
Date: Fri, 31 May 2024 10:26:04 +0200
Subject: [PATCH] Proposed template for bug reporting (#226)

---
 .github/ISSUE_TEMPLATE/bug_report.yml | 61 +++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml     |  9 ++++
 2 files changed, 70 insertions(+)
 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.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..4a468a581
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,61 @@
+name: Bug report
+description: Report to help us reproduce the bug
+title: "[Bug]: "
+
+body:
+- type: markdown 
+  attributes:
+    value: >
+        ## Thanks for taking the time to fill out this report
+- type: markdown 
+  attributes:
+    value: >
+       ### Before submitting a bug, please make sure it has not been reported in the 
+       [list of issues](https://github.com/narwhals-dev/narwhals/issues).
+- type: textarea
+  attributes:
+    label: Describe the bug
+    description: >
+       A clear description of the bug.
+  validations:
+       required: true
+- type: textarea
+  attributes:
+    label: Steps or code to reproduce the bug
+    description: |
+       Please add a minimal code example to reproduce the bug.
+  validations:
+       required: true 
+- type: textarea
+  attributes:
+    label: Expected results
+    description: >
+       Please paste or describe the expected results.
+    placeholder: >
+        Example: No error is thrown.
+  validations:
+        required: true
+- type: textarea
+  attributes:
+    label: Actual results
+    description: |
+      Please paste or describe the results you observe instead of the expected results. 
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Versions
+    render: shell
+    description: |
+      What version of Narwhals and dataframe libraries are you running?
+      You could run the following and provide the output below.
+      ```
+      pip freeze | grep -E "narwhals|polars|pandas|modin|cudf"
+      ```
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Relevant log output
+    description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+    render: shell
\ 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..f075cf509
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,9 @@
+contact_links:
+- name: Discord server
+  url: https://discord.gg/V3PqtB4VA4)
+  about: | 
+      Developers and users can be found on the Discord server.
+      Please note that GitHub Discussions should be used in most cases instead.  
+- name: Blank issue
+  url: https://github.com/narwhals-dev/narwhals/issues/new
+  
\ No newline at end of file