docs: Update issue templates

* Create icon_request.md

* Delete ISSUE_TEMPLATE.md

* Create bug_report.md

* creating an example bug report

* Using same bug report from issue template
This commit is contained in:
Yashu Mittal 2018-07-19 07:04:53 +05:30 committed by Cole Bemis
parent 156c0919c9
commit 8aec53b331
4 changed files with 98 additions and 15 deletions

View File

@ -1,10 +0,0 @@
<!--
If you'd like to request an icon, please provide the following information:
- icon name
- at least one use case
- screenshots of similar icons
Please create one issue for each icon request.
-->

67
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@ -0,0 +1,67 @@
---
name: Bug report
about: Create a report to help us improve
---
<!--
Before reporting an issue, please search to see if someone has filed a similar issue before. If there is already an open issue, please add a 👍 and/or leave a comment with additional information.
-->
## Prerequisites
* Version:
* Are you running from source/master:
* Are you using a released build:
* Operating system:
* Bits:
## Step to reproduce
*(Type here)*
### Actual behavior
## Any message or error
*(Type here)*
## Resources
* Links
* Screenshots
Here is what a great bug report would look like:
```
## Prerequisites
Version: Release v3.1.0
Running from: Import using webpack
Operating system: Mac OSX
Bits: 64 bits
## Step to reproduce
- Import `check` icon
- Add to a React component/view
- Run the react app
- Notice that the `check` isn't rendering correctly which seems a encoding problem
### Actual behavior:
- Import `check` icon
- Add to a React component/view
- Run the react app
- Check is displayed with correct encoding (e.g UTF-8)
## Any message or error
No console output
...
## Resources
No resources
...
```

14
.github/ISSUE_TEMPLATE/icon_request.md vendored Normal file
View File

@ -0,0 +1,14 @@
---
name: Icon request
about: Suggest an new icon for this project
---
<!--
Before creating an icon request, please search to see if someone has requested the icon already. If there is an open request, please add a 👍.
-->
## Icon Request
* Icon name:
* Use case:
* Screenshots of similar icons:

View File

@ -37,24 +37,36 @@ When creating a new issue make sure to include the following:
- A screenshot of any visual bug. - A screenshot of any visual bug.
Here is what a great bug report would look like: Here is what a great bug report would look like:
``` ```
Check not rendering properly ## Prerequisites
Version: Release v3.1.0 Version: Release v3.1.0
Downloaded from: Import using webpack Running from: Import using webpack
OS: Mac OSX Operating system: Mac OSX
Bits: 64 bits
## Step to reproduce
How to reproduce:
- Import `check` icon - Import `check` icon
- Add to a React component/view - Add to a React component/view
- Run the react app - Run the react app
- Notice that the `check` isn't rendering correctly which seems a encoding problem - Notice that the `check` isn't rendering correctly which seems a encoding problem
Actual result:
### Actual behavior:
- Import `check` icon - Import `check` icon
- Add to a React component/view - Add to a React component/view
- Run the react app - Run the react app
- Check is displayed with correct encoding (e.g UTF-8) - Check is displayed with correct encoding (e.g UTF-8)
## Any message or error
No console output No console output
... ...
## Resources
No resources
...
``` ```