From 003009cdad7f4c5cca73f9e2292b48878d557107 Mon Sep 17 00:00:00 2001 From: Pedro Rivero Date: Mon, 18 Apr 2022 12:58:10 -0400 Subject: [PATCH 1/2] Update issue templates - Update headers - Add commented descriptions and guidelines - Add additional context and suggestions to bug reports - Request system information for bug reports --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++-- .github/ISSUE_TEMPLATE/enhancement_request.md | 6 ++-- .github/ISSUE_TEMPLATE/feature_request.md | 6 ++-- 3 files changed, 35 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 58ced71..0262bf2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,14 +1,39 @@ --- name: 🐛 Bug report about: Create a report to help us improve 🤔. -labels: bug +labels: [bug] +title: '' +assignees: '' --- -### Steps to reproduce the problem +### System information + +- Device: (e.g. MacBook Pro (16-inch, 2019)) +- OS: (e.g. macOS Monterey version 12.3.1) +- Python version: (e.g. 3.8.9) +- Prototype version: (e.g. 1.0.0) + ### What is the current behavior? + + + ### What is the expected behavior? + + + +### Steps to reproduce the problem + + + + +### Additional context + + + +### Suggestions + diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md index e5bc9ee..82c5bff 100644 --- a/.github/ISSUE_TEMPLATE/enhancement_request.md +++ b/.github/ISSUE_TEMPLATE/enhancement_request.md @@ -1,11 +1,13 @@ --- name: 💅 Enhancement request about: Suggest an improvement for this project 🆒! -labels: 'type: enhancement' +labels: [enhancement] +title: '' +assignees: '' --- ### What is the expected enhancement? - + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index cd5e94b..dc69236 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,11 +1,13 @@ --- name: 🚀 Feature request about: Suggest an idea for this project 💡! -labels: 'type: feature request' +labels: [feature] +title: '' +assignees: '' --- ### What is the expected behavior? - + From 9bdfc20d5fe390c330136d6748a7365fb0cbeae9 Mon Sep 17 00:00:00 2001 From: Pedro Rivero Date: Tue, 19 Apr 2022 10:04:49 -0500 Subject: [PATCH 2/2] Examples in bug report template as HTML comments --- .github/ISSUE_TEMPLATE/bug_report.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0262bf2..16724fd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,10 +11,10 @@ assignees: '' ### System information -- Device: (e.g. MacBook Pro (16-inch, 2019)) -- OS: (e.g. macOS Monterey version 12.3.1) -- Python version: (e.g. 3.8.9) -- Prototype version: (e.g. 1.0.0) +- Device: +- OS: +- Python version: +- Prototype version: ### What is the current behavior?