From 99136f9bd67454584e9dd55c36a1f364f055e181 Mon Sep 17 00:00:00 2001 From: "felord.cn" Date: Sat, 11 Mar 2023 08:52:15 +0800 Subject: [PATCH] Update issue templates --- .../{bug_report.md => issues.md} | 4 +-- .github/ISSUE_TEMPLATE/提问.md | 27 +++++++++++++++++++ 2 files changed, 29 insertions(+), 2 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.md => issues.md} (92%) create mode 100644 .github/ISSUE_TEMPLATE/提问.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/issues.md similarity index 92% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/issues.md index a40aab5..9678da6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/issues.md @@ -1,6 +1,6 @@ --- -name: Bug report -about: Create a report to help us improve +name: issues +about: 向维护者提问以帮助改进 title: '' labels: '' assignees: '' diff --git a/.github/ISSUE_TEMPLATE/提问.md b/.github/ISSUE_TEMPLATE/提问.md new file mode 100644 index 0000000..8505ab8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/提问.md @@ -0,0 +1,27 @@ +--- +name: 提问 +about: 向维护者提问以帮助改进 +title: '' +labels: '' +assignees: '' + +--- + +**提问前的思考** +1. 我是否已经认真阅读了文档和相关操作说明 +2. 其它ISSUES是否已经有了解决方案 + +**描述问题** +提问时应该按照以下要点清晰地描述问题,才能得到可靠的答复 + +**环境版本信息** +问题发生的环境,不限于软件版本、运行时环境、操作系统等 + +**操作行为** +产生问题的操作行为 + +**期望的结果** +清晰地描述期望达成的结果 + +**代码与截图** +通常不建议使用代码截图,这样不太方便维护者进行Preview。代码应该使用Markdown代码块进行格式化。因交互导致的问题才建议使用截图辅助排查。