From 3a77899775c9a1866042b4a9f479a215aa407420 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Eren=20G=C3=B6lge?= <egolge@coqui.ai>
Date: Mon, 8 Nov 2021 09:19:37 +0100
Subject: [PATCH] Update issue and feature request templates

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 56 +++++++++++++++--------
 .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++-----
 2 files changed, 49 insertions(+), 30 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index c61ec019..de7e439d 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -6,33 +6,53 @@ labels: bug
 assignees: ''
 
 ---
+<!-- Welcome to the 🐸TTS!
+We are excited to see your interest, and appreciate your support! --->
+## 🐛 Description
 
-Welcome to the 🐸TTS project! We are excited to see your interest, and appreciate your support!
+<!-- A clear and concise description of what the bug is. -->
 
-This repository is governed by the Contributor Covenant Code of Conduct. For more details, see the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.
+### To Reproduce
 
-If you've found a bug, please provide the following information:
+<!--
+Please share your code to reproduce the error. Issues fixed faster if you can provide a working example.
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+The best place for sharing code is colab. https://colab.research.google.com/
+So we can directly run your code and reproduce the issue.
+
+In the worse case provide steps to reproduce the behaviour.
 
-**To Reproduce**
-Steps to reproduce the behavior:
 1. Run the following command '...'
 2. ...
 3. See error
+-->
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+### Expected behavior
 
-**Environment (please complete the following information):**
-- **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**:
-- **PyTorch or TensorFlow version (use command below)**:
-- **Python version**:
-- **CUDA/cuDNN version**:
-- **GPU model and memory**:
-- **Exact command to reproduce**:
+<!-- Write down what the expected behaviour -->
 
-**Additional context**
-Add any other context about the problem here.
+### Environment
 
+<!--
+You can either run `TTS/bin/collect_env_info.py`
+
+```bash
+wget https://raw.githubusercontent.com/coqui-ai/TTS/main/TTS/bin/collect_env_details.py
+python collect_env_details.py
+```
+
+or fill in the fields below manually.
+-->
+
+- 🐸TTS Version (e.g., 1.3.0):
+- PyTorch Version (e.g., 1.8)
+- Python version:
+- OS (e.g., Linux):
+- CUDA/cuDNN version:
+- GPU models and configuration:
+- How you installed PyTorch (`conda`, `pip`, source):
+- Any other relevant information:
+
+### Additional context
+
+<!-- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index d49aa707..941ab9b1 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -2,25 +2,24 @@
 name: 🚀 Feature request
 about: Suggest a feature or an idea for this project
 title: '[Feature request] '
-labels: feature request 
+labels: feature request
 assignees: ''
 
 ---
+<!-- Welcome to the 🐸TTS project!
+We are excited to see your interest, and appreciate your support! --->
+**🚀 Feature Description**
 
-Welcome to the 🐸TTS project! We are excited to see your interest, and appreciate your support!
+<!--A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 
-This repository is governed by the Contributor Covenant Code of Conduct. For more details, see the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.
+**Solution**
 
-If you have a feature request, then please provide the following information:
+<!-- A clear and concise description of what you want to happen. -->
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Alternative Solutions**
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
+
+<!-- Add any other context or screenshots about the feature request here. -->