From 793e8e107b98f88d1a4815334fb30e2e062fd0e0 Mon Sep 17 00:00:00 2001
From: Ayush Karnawat <ayush.karnawat97@gmail.com>
Date: Fri, 22 May 2020 10:43:05 -0400
Subject: [MRG] Templates (#181)

* Add a PR template

* move github contrib + code of conduct

* fix links

* add feature request template

* ask for gpu info

* address comments

* add gitter in README
---
 .github/ISSUE_TEMPLATE/bug_report.md | 43 ++++++++++++++++++++++++------------
 1 file changed, 29 insertions(+), 14 deletions(-)

(limited to '.github/ISSUE_TEMPLATE/bug_report.md')

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 7f8acda..f24d993 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,27 +1,42 @@
 ---
 name: Bug report
 about: Create a report to help us improve POT
+title: ''
+labels: bug, help wanted
+assignees: ''
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+## Describe the bug
+<!-- A clear and concise description of what the bug is. -->
 
-**To Reproduce**
+### To Reproduce
 Steps to reproduce the behavior:
-1 ...
+1. ...
 2. 
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+<!-- If you have error messages or stack traces, please provide it here as well -->
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+#### Screenshots
+<!-- If applicable, add screenshots to help explain your problem. -->
 
-**Desktop (please complete the following information):**
- - OS: [e.g. MacOSX, Windows, Ubuntu]
- - Python version [2.7,3.6]
-- How was POT installed [source, pip, conda]
+#### Code sample
+<!-- Ideally attach a minimal code sample to reproduce the decried issue. 
+Minimal means having the shortest code but still preserving the bug. -->
+
+### Expected behavior
+<!-- A clear and concise description of what you expected to happen. -->
+
+
+### Environment (please complete the following information):
+- OS (e.g. MacOS, Windows, Linux):
+- Python version:
+- How was POT installed (source, `pip`, `conda`):
+- Build command you used (if compiling from source):
+- Only for GPU related bugs:
+    - CUDA version:
+    - GPU models and configuration:
+    - Any other relevant information:
 
 Output of the following code snippet:
 ```python
@@ -32,5 +47,5 @@ import scipy; print("SciPy", scipy.__version__)
 import ot; print("POT", ot.__version__)
 ```
 
-**Additional context**
-Add any other context about the problem here.
+### Additional context
+<!-- Add any other context about the problem here. -->
-- 
cgit v1.2.3