From 01eac7c9ed38373791b1921a675f9efc6d7ff2f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eren=20G=C3=B6lge?= Date: Thu, 10 Mar 2022 18:18:56 +0100 Subject: [PATCH 1/2] Add bug_report template --- .github/ISSUE_TEMPLATE/bug_report.md | 58 ------------------ .github/ISSUE_TEMPLATE/bug_report.yaml | 83 ++++++++++++++++++++++++++ 2 files changed, 83 insertions(+), 58 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 133346f69f..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: 🐛 Bug report -about: Create a bug report to help 🐸 improve -title: '[Bug] ' -labels: bug -assignees: '' - ---- - -## 🐛 Description - - - -### To Reproduce - - - -### Expected behavior - - - -### Environment - - - -- 🐸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 - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000000..835d798702 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,83 @@ +name: "🐛 Bug report" +description: Create a bug report to help 🐸 improve +title: '[Bug] ' +labels: [ "bug" ] +body: + - type: markdown + attributes: + value: | + Welcome to the 🐸TTS! Thanks for taking the time to fill out this bug report! + + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: Bug description + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: To Reproduce + description: | + Please share your code to reproduce the error. Issues fixed faster if you can provide a working example. + + 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. + + 1. Run the following command '...' + 2. ... + 3. See error + placeholder: Reproduction + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: "Write down what the expected behaviour" + + - type: textarea + id: logs + attributes: + label: Logs + description: "Please include the relevant logs if you can." + render: shell + + - type: textarea + id: system-info + attributes: + label: Environment + description: | + You can either run `TTS/bin/collect_env_info.py` + + ```bash + wget https://raw.githubusercontent.com/coqui-ai/TTS/main/TTS/bin/collect_env_info.py + python collect_env_info.py + ``` + + or fill in the fields below manually. + render: shell + placeholder: | + - 🐸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: + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false From b2c474082e33ceaed923cb1c4de958656c82c3e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eren=20G=C3=B6lge?= Date: Thu, 10 Mar 2022 18:28:36 +0100 Subject: [PATCH 2/2] Fix typos --- .github/ISSUE_TEMPLATE/bug_report.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 835d798702..34cde7e844 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -22,12 +22,14 @@ body: attributes: label: To Reproduce description: | - Please share your code to reproduce the error. Issues fixed faster if you can provide a working example. + Please share your code to reproduce the error. + + Issues are fixed faster if you can provide a working example. 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. + In the worse case, provide steps to reproduce the behavior. 1. Run the following command '...' 2. ...