From e55a13439ec297081d33a7eb2f87ece605581908 Mon Sep 17 00:00:00 2001 From: Haoliang Gao Date: Tue, 9 May 2017 11:53:10 +0800 Subject: [PATCH] docs: Add a link to issue template (#853) --- .github/ISSUE_TEMPLATE.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index b021f100e8..f607fc4d09 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -2,14 +2,18 @@ Thank you for reporting an issue. 1. It's RECOMMENDED to submit PR for typo or tiny bug fix. -2. If this's a BUG, please provide: course repetition, error log and configuration. Fill in as much of the template below as you're able. -3. If this's a FEATURE request, please provide: details, pseudo codes if necessary. +2. If this's a FEATURE request, please provide: details, pseudo codes if necessary. +3. If this's a BUG, please provide: course repetition, error log and configuration. Fill in as much of the template below as you're able. +4. It will be nice to use `egg-init --type=simple bug` to provide a mini GitHub repository which can reproduce the issue. 感谢您向我们反馈问题。 -1. 我们推荐如果是小问题（错别字修改，小的 bug fix）直接提交 PR。 -2. 如果是一个 BUG，请提供：复现步骤，错误日志以及相关配置，并尽量填写下面的模板中的条目。 +1. 提交问题前，请先阅读 https://eggjs.org/zh-cn/faq.html +2. 我们推荐如果是小问题（错别字修改，小的 bug fix）直接提交 PR。 3. 如果是一个新需求，请提供：详细需求描述，最好是有伪代码实现。 +4. 如果是一个 BUG，请提供：复现步骤，错误日志以及相关配置，并尽量填写下面的模板中的条目。 +5. 如果可以，请使用 `egg-init --type=simple bug` 提供一个最小可复现的代码仓库，方便我们排查问题。 +6. 扩展阅读：[如何向开源项目提交无法解答的问题](https://zhuanlan.zhihu.com/p/25795393) --> * **Node Version**: @@ -17,5 +21,6 @@ Thank you for reporting an issue. * **Plugin Name**: * **Plugin Version**: * **Platform**: +* **Mini Showcase Repository**: