Skip to content

Commit 8aec53b

Browse files
mittalyashucolebemis
authored andcommitted
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
1 parent 156c091 commit 8aec53b

File tree

4 files changed

+98
-15
lines changed

4 files changed

+98
-15
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
---
5+
6+
<!--
7+
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.
8+
-->
9+
10+
## Prerequisites
11+
12+
* Version:
13+
* Are you running from source/master:
14+
* Are you using a released build:
15+
* Operating system:
16+
* Bits:
17+
18+
## Step to reproduce
19+
20+
*(Type here)*
21+
22+
### Actual behavior
23+
24+
## Any message or error
25+
26+
*(Type here)*
27+
28+
## Resources
29+
30+
* Links
31+
* Screenshots
32+
33+
34+
Here is what a great bug report would look like:
35+
36+
```
37+
## Prerequisites
38+
39+
Version: Release v3.1.0
40+
Running from: Import using webpack
41+
Operating system: Mac OSX
42+
Bits: 64 bits
43+
44+
## Step to reproduce
45+
46+
- Import `check` icon
47+
- Add to a React component/view
48+
- Run the react app
49+
- Notice that the `check` isn't rendering correctly which seems a encoding problem
50+
51+
### Actual behavior:
52+
53+
- Import `check` icon
54+
- Add to a React component/view
55+
- Run the react app
56+
- Check is displayed with correct encoding (e.g UTF-8)
57+
58+
## Any message or error
59+
60+
No console output
61+
...
62+
63+
## Resources
64+
65+
No resources
66+
...
67+
```
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Icon request
3+
about: Suggest an new icon for this project
4+
---
5+
6+
<!--
7+
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 👍.
8+
-->
9+
10+
## Icon Request
11+
12+
* Icon name:
13+
* Use case:
14+
* Screenshots of similar icons:

CONTRIBUTING.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,24 +37,36 @@ When creating a new issue make sure to include the following:
3737
- A screenshot of any visual bug.
3838

3939
Here is what a great bug report would look like:
40+
4041
```
41-
Check not rendering properly
42+
## Prerequisites
4243
4344
Version: Release v3.1.0
44-
Downloaded from: Import using webpack
45-
OS: Mac OSX
45+
Running from: Import using webpack
46+
Operating system: Mac OSX
47+
Bits: 64 bits
48+
49+
## Step to reproduce
4650
47-
How to reproduce:
4851
- Import `check` icon
4952
- Add to a React component/view
5053
- Run the react app
5154
- Notice that the `check` isn't rendering correctly which seems a encoding problem
52-
Actual result:
55+
56+
### Actual behavior:
57+
5358
- Import `check` icon
5459
- Add to a React component/view
5560
- Run the react app
5661
- Check is displayed with correct encoding (e.g UTF-8)
5762
63+
## Any message or error
64+
5865
No console output
5966
...
67+
68+
## Resources
69+
70+
No resources
71+
...
6072
```

0 commit comments

Comments
 (0)