From 47bb466aa19395b7785bcb830e2e4dd35f6bafc5 Mon Sep 17 00:00:00 2001 From: Yuhui Zheng <10982575+yuhui-zheng@users.noreply.github.com> Date: Tue, 17 Mar 2020 13:07:44 -0700 Subject: [PATCH] Update issue templates Template maintenance. - adding title prefix. - adding examples to "additional context" section. --- .github/ISSUE_TEMPLATE/bug_report.md | 2 ++ .github/ISSUE_TEMPLATE/documentation-issue.md | 2 +- .github/ISSUE_TEMPLATE/general-inquiry.md | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3c0dee799d..d44477c032 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -32,3 +32,5 @@ If applicable, add screenshots to help explain your problem. **Additional context** Add any other context about the problem here. +e.g. code snippet to reproduce the issue. +e.g. stack trace, memory dump, debugger log, and many etc. diff --git a/.github/ISSUE_TEMPLATE/documentation-issue.md b/.github/ISSUE_TEMPLATE/documentation-issue.md index a52216fb07..062a678b53 100644 --- a/.github/ISSUE_TEMPLATE/documentation-issue.md +++ b/.github/ISSUE_TEMPLATE/documentation-issue.md @@ -1,7 +1,7 @@ --- name: Documentation issue about: Create a report to help us improve our documentation. -title: '' +title: "[DOC]" labels: documentation assignees: '' diff --git a/.github/ISSUE_TEMPLATE/general-inquiry.md b/.github/ISSUE_TEMPLATE/general-inquiry.md index 9923da0930..d3b8baf701 100644 --- a/.github/ISSUE_TEMPLATE/general-inquiry.md +++ b/.github/ISSUE_TEMPLATE/general-inquiry.md @@ -1,7 +1,7 @@ --- name: General inquiry about: Free form communication. -title: '' +title: "[Inquiry]" labels: question assignees: ''