From 499bc3a6f35725bdd573417ab18cafaf1e26bb72 Mon Sep 17 00:00:00 2001 From: TZ Date: Thu, 21 Dec 2017 09:20:11 +0800 Subject: [PATCH 1/2] docs(faq): add rule for issue --- docs/source/en/faq.md | 14 +++++++++++++- docs/source/zh-cn/faq.md | 12 ++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/source/en/faq.md b/docs/source/en/faq.md index f64fddbc93..8d62c17fb2 100644 --- a/docs/source/en/faq.md +++ b/docs/source/en/faq.md @@ -3,7 +3,19 @@ title: FAQ If you have questions that is not contained below, please check [Egg issues](https://github.com/eggjs/egg/issues). -## Why my config don't work ? +## How to feedback efficiently? + +Thank you for reporting an issue. + +1. It's RECOMMENDED to submit PR for typo or tiny bug fix. +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.** + +Most importantly, please understand one thing: the relationship between the `user` and `the maintainer of open source project` is not `Buyer` and `Seller`, the issue is not a customer order either. +When you're opening an issue, please hold a mentality of "working together to solve this problem." Do not expect us to serve you unilaterally. + +## Why my config don't work? Framework [Config](./basics/config.md) settings is powerfull, support different environments and different places(framework, plugins, app). diff --git a/docs/source/zh-cn/faq.md b/docs/source/zh-cn/faq.md index eeccd48cc9..86c625611d 100644 --- a/docs/source/zh-cn/faq.md +++ b/docs/source/zh-cn/faq.md @@ -3,6 +3,18 @@ title: 常见问题 如果下面的内容无法解决你的问题，请查看 [Egg issues](https://github.com/eggjs/egg/issues)。 +## 如何高效的反馈问题？ + +感谢您向我们反馈问题。 + +1. 我们推荐如果是小问题（错别字修改，小的 bug fix）直接提交 PR。 +2. 如果是一个新需求，请提供：详细需求描述，最好是有伪代码示意。 +3. 如果是一个 BUG，请提供：复现步骤，错误日志以及相关配置，并尽量填写下面的模板中的条目。 +4. **如果可以，仅可能使用 `egg-init --type=simple bug` 提供一个最小可复现的代码仓库，方便我们排查问题。** +5. 不要挤牙膏似的交流，扩展阅读：[如何向开源项目提交无法解答的问题](https://zhuanlan.zhihu.com/p/25795393) + +最重要的是，请明白一件事：开源项目的用户和维护者之间并不是甲方和乙方的关系，issue 也不是客服工单。在开 issue 的时候，请抱着一种『一起合作来解决这个问题』的心态，不要期待我们单方面地为你服务。 + ## 为什么我的配置不生效？ 框架的配置功能比较强大，有不同环境变量，又有框架、插件、应用等很多地方配置。 From 9e213b317c3f1453f23b79e2d97696901d2a9a03 Mon Sep 17 00:00:00 2001 From: TZ Date: Thu, 21 Dec 2017 09:29:08 +0800 Subject: [PATCH 2/2] f --- docs/source/zh-cn/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/zh-cn/faq.md b/docs/source/zh-cn/faq.md index 86c625611d..52749de58c 100644 --- a/docs/source/zh-cn/faq.md +++ b/docs/source/zh-cn/faq.md @@ -10,7 +10,7 @@ title: 常见问题 1. 我们推荐如果是小问题（错别字修改，小的 bug fix）直接提交 PR。 2. 如果是一个新需求，请提供：详细需求描述，最好是有伪代码示意。 3. 如果是一个 BUG，请提供：复现步骤，错误日志以及相关配置，并尽量填写下面的模板中的条目。 -4. **如果可以，仅可能使用 `egg-init --type=simple bug` 提供一个最小可复现的代码仓库，方便我们排查问题。** +4. **如果可以，尽可能使用 `egg-init --type=simple bug` 提供一个最小可复现的代码仓库，方便我们排查问题。** 5. 不要挤牙膏似的交流，扩展阅读：[如何向开源项目提交无法解答的问题](https://zhuanlan.zhihu.com/p/25795393) 最重要的是，请明白一件事：开源项目的用户和维护者之间并不是甲方和乙方的关系，issue 也不是客服工单。在开 issue 的时候，请抱着一种『一起合作来解决这个问题』的心态，不要期待我们单方面地为你服务。