Browse Source

Github: Add Chinese issue and feature request templates (#3461)

wxq 4 years ago
parent
commit
d940c4a049

+ 36 - 34
.github/ISSUE_TEMPLATE/bug_report.md → .github/ISSUE_TEMPLATE/bug_report_en.md

@@ -1,34 +1,36 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-- [ ] I have searched the [issues](https://github.com/ctripcorp/apollo/issues) of this repository and believe that this is not a duplicate.
-- [ ] I have checked the [FAQ](https://github.com/ctripcorp/apollo/wiki/%E9%83%A8%E7%BD%B2&%E5%BC%80%E5%8F%91%E9%81%87%E5%88%B0%E7%9A%84%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98) of this repository and believe that this is not a duplicate.
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. 
-2. 
-3. 
-4. 
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-### Additional Details & Logs
-
-- Version
-- Error logs
-- Configuration
-- Platform and Operating System
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+<!-- The content in here will not be show。To forbid duplication,easier search in the feature,before you create an issue,please check the following. If your question is a newer/beginner's,recommand to https://github.com/ctripcorp/apollo/discussions to ask it. -->
+
+- [ ] I have checked the [discussions](https://github.com/ctripcorp/apollo/discussions)
+- [ ] I have searched the [issues](https://github.com/ctripcorp/apollo/issues) of this repository and believe that this is not a duplicate.
+- [ ] I have checked the [FAQ](https://github.com/ctripcorp/apollo/wiki/%E9%83%A8%E7%BD%B2&%E5%BC%80%E5%8F%91%E9%81%87%E5%88%B0%E7%9A%84%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98) of this repository and believe that this is not a duplicate.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. 
+2. 
+3. 
+4. 
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+### Additional Details & Logs
+
+- Version
+- Error logs
+- Configuration
+- Platform and Operating System

+ 41 - 0
.github/ISSUE_TEMPLATE/bug_report_zh.md

@@ -0,0 +1,41 @@
+---
+name: 报告Bug/使用疑问
+about: 提交Apollo Bug/使用疑问,使用这个模板
+title: ''
+labels: ''
+assignees: ''
+---
+
+<!-- 这段文字不会显示在你的内容中。为了避免重复的信息,方便后续的检索,在提issue之前,请检查如下事项。如果是比较新手级别的问题,推荐到讨论区https://github.com/ctripcorp/apollo/discussions 提问 -->
+
+- [ ] 我已经检查过[discussions](https://github.com/ctripcorp/apollo/discussions)
+- [ ] 我已经搜索过[issues](https://github.com/ctripcorp/apollo/issues)
+- [ ] 我已经仔细检查过[FAQ](https://github.com/ctripcorp/apollo/wiki/%E9%83%A8%E7%BD%B2&%E5%BC%80%E5%8F%91%E9%81%87%E5%88%B0%E7%9A%84%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)
+
+**描述bug**
+
+简洁明了地描述一下bug
+
+**复现**
+
+通过如下步骤可以复现:
+
+1. 
+2. 
+3. 
+4. 
+
+**期望**
+
+简介明了地描述你希望正常情况下应该发生什么
+
+**截图**
+
+如果可以,附上截图来描述你的问题
+
+### 额外的细节和日志
+
+- 版本:
+- 错误日志
+- 配置:
+- 平台和操作系统

+ 20 - 20
.github/ISSUE_TEMPLATE/feature_request.md → .github/ISSUE_TEMPLATE/feature_request_en.md

@@ -1,20 +1,20 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

+ 25 - 0
.github/ISSUE_TEMPLATE/feature_request_zh.md

@@ -0,0 +1,25 @@
+---
+name: 请求特性
+about: 给这个项目提一些建议、想法
+title: ''
+labels: ''
+assignees: ''
+---
+
+**你的特性请求和某个问题有关吗?请描述**
+
+清晰简洁地描述这个问题是什么。即,当碰到xxx时,总是感觉很麻烦
+
+
+
+**清晰简洁地描述一下你希望的解决方案**
+
+
+
+**清晰简洁地描述一下这个特性的备选方案**
+
+
+
+**其它背景**
+
+在这里添加和这个特性请求有关的背景说明、截图