Skip to content

Commit

Permalink
docs: add issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
BuptStEve committed Feb 1, 2019
1 parent c2d940e commit c0f73f2
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_cn.md
Original file line number Diff line number Diff line change
@@ -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

**预期行为**
简洁清晰地描述一下预期行为。

**附加上下文**
添加一些问题的相关上下文。
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request_cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 添加 Feature
about: 新特性支持
title: 'feat: your feature...'
labels: enhancement
assignees: BuptStEve

---

**你的功能请求是否与某些问题相关?请描述**
简洁清晰地描述一下当前有什么问题。如果方便的话,添加一些截图描述你的问题。

**描述您想要的解决方案**
简洁清晰地描述一下你想要的特性是怎样的。

**描述你考虑过的备选方案**
简洁清晰地描述一下你考虑过的其他备选方案,可能会有什么问题。

**附加上下文**
添加一些问题的相关上下文。

0 comments on commit c0f73f2

Please sign in to comment.