From c0f73f2565097393f800f66bb0e51048aa887fb1 Mon Sep 17 00:00:00 2001 From: stevezyyang Date: Fri, 1 Feb 2019 15:43:11 +0800 Subject: [PATCH] docs: add issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report_cn.md | 36 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++ .github/ISSUE_TEMPLATE/feature_request_cn.md | 20 +++++++++++ 4 files changed, 111 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report_cn.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request_cn.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..5bf1044 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Create a report to help us improve +title: 'bug: your bug...' +labels: bug +assignees: BuptStEve + +--- + +**Version** +Version [e.g. 0.1.0] + +**Describe the bug** +A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +If it's convenient: + +* Add an online address to reproduce: + * codepen: https://codepen.io/ + * jsfiddle: https://jsfiddle.net/ + * codesandbox: https://codesandbox.io/ +* Add a repository to reproduce:https://github.com/new + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report_cn.md b/.github/ISSUE_TEMPLATE/bug_report_cn.md new file mode 100644 index 0000000..da7c123 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report_cn.md @@ -0,0 +1,36 @@ +--- +name: 报告 Bug +about: 发现了一个 bug! +title: 'bug: your bug...' +labels: bug +assignees: BuptStEve + +--- + +**版本** +Version [e.g. 0.1.0] + +**描述一下 bug** +简洁清晰地描述一下 bug。如果方便的话,添加一些截图描述你的问题。 + +**复现 bug** +复现的步骤: + +1. 首先 '...' +2. 点击了 '...' +3. 滚动到了 '...' +4. 看到了错误 + +如果方便的话: + +* 复现 bug 的在线地址: + * codepen: https://codepen.io/ + * jsfiddle: https://jsfiddle.net/ + * codesandbox: https://codesandbox.io/ +* 复现 bug 的仓库地址:https://github.com/new + +**预期行为** +简洁清晰地描述一下预期行为。 + +**附加上下文** +添加一些问题的相关上下文。 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..c49c173 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: 'feat: your feature...' +labels: enhancement +assignees: BuptStEve + +--- + +**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. diff --git a/.github/ISSUE_TEMPLATE/feature_request_cn.md b/.github/ISSUE_TEMPLATE/feature_request_cn.md new file mode 100644 index 0000000..eb49bf2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request_cn.md @@ -0,0 +1,20 @@ +--- +name: 添加 Feature +about: 新特性支持 +title: 'feat: your feature...' +labels: enhancement +assignees: BuptStEve + +--- + +**你的功能请求是否与某些问题相关?请描述** +简洁清晰地描述一下当前有什么问题。如果方便的话,添加一些截图描述你的问题。 + +**描述您想要的解决方案** +简洁清晰地描述一下你想要的特性是怎样的。 + +**描述你考虑过的备选方案** +简洁清晰地描述一下你考虑过的其他备选方案,可能会有什么问题。 + +**附加上下文** +添加一些问题的相关上下文。