Skip to content

Commit 1ca5cd1

Browse files
rfprodrfprod
authored
docs(github): improve issue template (#13)
- [x] convert issue templates from md to yml forms;
1 parent ff345ab commit 1ca5cd1

File tree

7 files changed

+239
-81
lines changed

7 files changed

+239
-81
lines changed

‎.github/ISSUE_TEMPLATE/BUG-REPORT.yml

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
name: Bug Report
2+
description: Create a bug report to help us improve
3+
title: "[Bug]: "
4+
labels: ["Bug"]
5+
assignees:
6+
- rfprod
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
- type: input
13+
id: contact
14+
attributes:
15+
label: Contact Details
16+
description: If you want us to be able to get in touch with you directly via email if we need more info, please specify your email.
17+
placeholder: ex. email@example.com
18+
validations:
19+
required: false
20+
- type: textarea
21+
id: what-happened
22+
attributes:
23+
label: What happened?
24+
description: Describe the bug
25+
placeholder: A clear and concise description of what the bug is.
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: reproduction
30+
attributes:
31+
label: How to reproduce?
32+
description: A list of steps to reproduce the unwanted behavior.
33+
placeholder: |
34+
1. In this environment...
35+
2. With this config...
36+
3. Run '...'
37+
4. See error...
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: expected-behavior
42+
attributes:
43+
label: What did you expect?
44+
description: Describe the expected behavior
45+
placeholder: A clear and concise description of what you expected to happen.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: device-specification-and-environment
50+
attributes:
51+
label: Device specification and environment
52+
description: |
53+
Filling in the device specification and environment helps address the issue faster.
54+
- type: device type [e.g. desktop, laptop, tablet, smartphone]
55+
- OS: operating system [e.g. Ubuntu 20.04, Windows 10, Android 12, iOS 8.1]
56+
- Node: nodejs version [e.g. 13.14.0, 16.6.0, N/A]
57+
- npm: npm version [e.g. 13.14.0, 16.6.0, N/A]
58+
- yarn: yarn version [e.g. 1.22.17, 1.22.19, N/A]
59+
Examples:
60+
- **type**: desktop
61+
- **OS**: Ubuntu 20.04
62+
- **Node**: 13.14.0
63+
- **npm**: 7.6.3
64+
- **yarn**: 1.22.19
65+
value: |
66+
- type:
67+
- OS:
68+
- Node:
69+
- npm:
70+
- yarn:
71+
render: Markdown
72+
validations:
73+
required: false
74+
- type: dropdown
75+
id: browsers
76+
attributes:
77+
label: What browsers are you seeing the problem on?
78+
multiple: true
79+
options:
80+
- N/A
81+
- Firefox
82+
- Chrome
83+
- Chromium
84+
- Safari
85+
- Microsoft Edge
86+
- type: textarea
87+
id: logs
88+
attributes:
89+
label: Relevant log output
90+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
91+
render: shell
92+
- type: textarea
93+
id: additional-context
94+
attributes:
95+
label: Additional context
96+
description: |
97+
Links? References? Anything that will give us more context about the issue you are encountering!
98+
99+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
100+
validations:
101+
required: false
102+
- type: checkboxes
103+
id: terms
104+
attributes:
105+
label: Code of Conduct
106+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/rfprod/material-design-icon-fonts-self-hosted-web/blob/main/CODE_OF_CONDUCT.md)
107+
options:
108+
- label: I agree to follow this project's Code of Conduct
109+
required: true

‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature]: "
4+
labels: ["Feature"]
5+
assignees:
6+
- rfprod
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this feature request!
12+
- type: input
13+
id: contact
14+
attributes:
15+
label: Contact Details
16+
description: If you want us to be able to get in touch with you directly via email if we need more info, please specify your email.
17+
placeholder: ex. email@example.com
18+
validations:
19+
required: false
20+
- type: textarea
21+
id: problem-description
22+
attributes:
23+
label: Problem description
24+
description: Is your feature request relateed to a specific problem? Please describe.
25+
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: preferred-solution
30+
attributes:
31+
label: Preferred solution description
32+
description: Describe the solution you'd like.
33+
placeholder: A clear and concise description of what you want to happen.
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: alternative-solutions
38+
attributes:
39+
label: Alternative solutions description
40+
description: Describe alternatives you've considered.
41+
placeholder: A clear and concise description of any alternative solutions or features you've considered.
42+
validations:
43+
required: false
44+
- type: textarea
45+
id: additional-context
46+
attributes:
47+
label: Additional context
48+
description: |
49+
Links? References? Anything that will give us more context about the feature you are requesting!
50+
51+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
52+
validations:
53+
required: false
54+
- type: checkboxes
55+
id: terms
56+
attributes:
57+
label: Code of Conduct
58+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/rfprod/material-design-icon-fonts-self-hosted-web/blob/main/CODE_OF_CONDUCT.md)
59+
options:
60+
- label: I agree to follow this project's Code of Conduct
61+
required: true

‎.github/ISSUE_TEMPLATE/MAINTENANCE-REQUEST.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Maintenance Request
2+
description: Suggest an idea for this project maintenance
3+
title: "[Maintenance]: "
4+
labels: ["Maintenance"]
5+
assignees:
6+
- rfprod
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this maintenance request!
12+
- type: input
13+
id: contact
14+
attributes:
15+
label: Contact Details
16+
description: If you want us to be able to get in touch with you directly via email if we need more info, please specify your email.
17+
placeholder: ex. email@example.com
18+
validations:
19+
required: false
20+
- type: textarea
21+
id: problem-description
22+
attributes:
23+
label: Problem description
24+
description: Is your maintenance request relateed to a specific problem? Please describe.
25+
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: preferred-solution
30+
attributes:
31+
label: Preferred solution description
32+
description: Describe the solution you'd like.
33+
placeholder: A clear and concise description of the idea. Ex. improve project modularity, break down big libraries into smaller ones, decouple unrelated logic, update the project dependencies [...]
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: alternative-solutions
38+
attributes:
39+
label: Alternative solutions description
40+
description: Describe alternatives you've considered.
41+
placeholder: A clear and concise description of any alternative solutions or features you've considered.
42+
validations:
43+
required: false
44+
- type: textarea
45+
id: additional-context
46+
attributes:
47+
label: Additional context
48+
description: |
49+
Links? References? Anything that will give us more context about the feature you are requesting!
50+
51+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
52+
validations:
53+
required: false
54+
- type: checkboxes
55+
id: terms
56+
attributes:
57+
label: Code of Conduct
58+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/rfprod/material-design-icon-fonts-self-hosted-web/blob/main/CODE_OF_CONDUCT.md)
59+
options:
60+
- label: I agree to follow this project's Code of Conduct
61+
required: true

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Community Support
4+
url: https://github.com/rfprod/material-design-icon-fonts-self-hosted-web/discussions
5+
about: Please ask and answer questions here.
6+
- name: GitHub Security Bug Bounty
7+
url: https://bounty.github.com/
8+
about: Please report security vulnerabilities here.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/maintenance.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)