Skip to content

Commit 80aeaf8

Browse files
SnailedltPanquesito7
Snailedlt
and
Panquesito7
authored
Improve the issue templates (#1515)
* Update issue templates for icon requests fix #1467 * Minor issue template refactorings * Update .github/ISSUE_TEMPLATE/icon_request.yml Co-authored-by: David Leal <[email protected]> * Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: David Leal <[email protected]> * Update .github/ISSUE_TEMPLATE/config.yml * fix indenting --------- Co-authored-by: David Leal <[email protected]>
1 parent f5fa2ec commit 80aeaf8

File tree

5 files changed

+170
-147
lines changed

5 files changed

+170
-147
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
1-
name: Bug Report
2-
description: Report a bug/issue that you found in the SVGs, CSS files, or any other bug you encounter.
3-
title: '[BUG]: <bug name>'
4-
labels: [bug]
5-
body:
6-
- type: markdown
7-
attributes:
8-
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
9-
10-
- type: checkboxes
11-
attributes:
12-
label: I have searched through the issues and didn't find my problem.
13-
options:
14-
- label: Confirm
15-
required: true
16-
17-
- type: textarea
18-
id: description
19-
attributes:
20-
label: Bug description
21-
description: Short description of the bug. Provide images/code if applicable.
22-
validations:
23-
required: true
24-
25-
- type: textarea
26-
id: howtoreplicate
27-
attributes:
28-
label: Possible fixes or solutions
29-
description: List any possible fixes/suggestions that you have in mind that could solve this issue.
30-
validations:
31-
required: true
32-
33-
- type: textarea
34-
id: extrainformation
35-
attributes:
36-
label: Additional information
37-
description: Is there anything else we should know about this bug?
1+
name: Bug Report
2+
description: Report a bug/issue that you found in the SVGs, CSS files, or any other bug you encounter.
3+
title: '[BUG]: bug name'
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
9+
10+
- type: checkboxes
11+
attributes:
12+
label: I have searched through the issues and didn't find my problem.
13+
options:
14+
- label: Confirm
15+
required: true
16+
17+
- type: textarea
18+
id: description
19+
attributes:
20+
label: Bug description
21+
description: Short description of the bug. Provide images/code if applicable.
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: howtoreplicate
27+
attributes:
28+
label: Possible fixes or solutions
29+
description: List any possible fixes/suggestions that you have in mind that could solve this issue.
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: extrainformation
35+
attributes:
36+
label: Additional information
37+
description: Is there anything else we should know about this bug?

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ blank_issues_enabled: false
22
contact_links:
33
- name: Discord community
44
url: https://discord.gg/hScy8KWACQ
5-
about: Found any bug? Need help? Feel free to contact us via Discord.
5+
about: Found a bug? Need help? Feel free to contact us via Discord.

‎.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
1-
name: Feature Request
2-
description: Requesting a new feature or changes to an existing feature
3-
title: '[FEATURE REQUEST]: <feature name>'
4-
labels: [enhancement]
5-
body:
6-
- type: markdown
7-
attributes:
8-
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
9-
10-
- type: checkboxes
11-
attributes:
12-
label: I have searched through the issues and didn't find my problem.
13-
options:
14-
- label: Confirm
15-
required: true
16-
17-
- type: textarea
18-
id: description
19-
attributes:
20-
label: Description
21-
description: Write down a detailed description of the feature.
22-
validations:
23-
required: true
24-
25-
- type: textarea
26-
id: context
27-
attributes:
28-
label: Context
29-
description: Why is this change important to you? How would you use it? How can it benefit other users?
30-
validations:
31-
required: true
32-
33-
- type: textarea
34-
id: possiblesolution
35-
attributes:
36-
label: Possible Solution
37-
description: If you have an idea, please tell us what might solve the above problem and the benefits it provides.
38-
39-
- type: textarea
40-
id: extrainformation
41-
attributes:
42-
label: Additional information
43-
description: Is there anything else we should know about this feature request?
1+
name: Feature Request
2+
description: Requesting a new feature or changes to an existing feature
3+
title: '[FEATURE REQUEST]: feature name'
4+
labels: [enhancement]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
9+
10+
- type: checkboxes
11+
attributes:
12+
label: "I have searched through the issues and didn't find my problem."
13+
options:
14+
- label: Confirm
15+
required: true
16+
17+
- type: textarea
18+
id: description
19+
attributes:
20+
label: Description
21+
description: Write down a detailed description of the feature.
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: context
27+
attributes:
28+
label: Context
29+
description: Why is this change important to you? How would you use it? How can it benefit other users?
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: possiblesolution
35+
attributes:
36+
label: Possible Solution
37+
description: If you have an idea, please tell us what might solve the above problem and the benefits it provides.
38+
39+
- type: textarea
40+
id: extrainformation
41+
attributes:
42+
label: Additional information
43+
description: Is there anything else we should know about this feature request?

‎.github/ISSUE_TEMPLATE/icon_request.yml

Lines changed: 60 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,60 @@
1-
name: Icon Request
2-
description: Request a new icon, or changes to an existing icon
3-
title: '[ICON REQUEST]: <icon name>'
4-
labels: ["request:icon"]
5-
body:
6-
- type: markdown
7-
attributes:
8-
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
9-
10-
- type: checkboxes
11-
attributes:
12-
label: I have searched through the issues and didn't find my problem.
13-
options:
14-
- label: Confirm
15-
required: true
16-
17-
- type: input
18-
id: about
19-
attributes:
20-
label: About the icon
21-
description: Short description of why you think this icon belongs in our project.
22-
validations:
23-
required: true
24-
25-
- type: textarea
26-
id: links
27-
attributes:
28-
label: Links and sources
29-
description: Provide links to the icon's official website/repository/anywhere that shows what the technology is about, and its official logo. If available, also provide some resources where the icon/SVG can be found (Font Awesome, Icomoon, etc.).
30-
validations:
31-
required: true
32-
33-
- type: textarea
34-
id: extrainformation
35-
attributes:
36-
label: Additional information
37-
description: Is there anything else we should know about this icon?
1+
name: Icon Request
2+
description: Request a new icon, or changes to an existing icon
3+
title: '[ICON REQUEST]: icon name'
4+
labels: ["request:icon"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
9+
10+
- type: checkboxes
11+
attributes:
12+
label: I have searched through the issues and didn't find my problem.
13+
options:
14+
- label: Confirm
15+
required: true
16+
17+
- type: input
18+
id: about
19+
attributes:
20+
label: About the icon
21+
description: Short description of why you think this icon belongs in our project.
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: links
27+
attributes:
28+
label: Links and sources
29+
description: Provide links to the icon's official website/repository/anywhere that shows what the technology is about, and its official logo. If available, also provide some resources where the icon/SVG can be found (Font Awesome, Icomoon, etc.).
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: icons
35+
attributes:
36+
label: Icon links and previews
37+
description: |
38+
Provide previews and links to official icons (preferably SVG's).
39+
*If there are no offical icons, or if you feel unofficial ones should be used instead, please add them here.*
40+
41+
Example:
42+
```md
43+
#### jule-original
44+
<img alt="Git" width="100px" src="https://raw.githubusercontent.com/julelang/resources/6b1f4e68a8258435d87f29b9b2206b20a321f54e/jule.svg" ></img>
45+
https://github.com/julelang/resources/blob/main/jule.svg
46+
```
47+
value: |
48+
#### iconname-version-name
49+
<img width="100px" src="previewable_link_to_icon" ></img>
50+
link_to_icon
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: extrainformation
56+
attributes:
57+
label: Additional information
58+
description: |
59+
Is there anything else we should know about this icon?
60+
Recommended tags, altnames, and color to be added to [`devicon.json`](https://github.com/devicons/devicon/wiki/Updating-%60devicon.json%60) can also be added here

‎.github/ISSUE_TEMPLATE/other.yml

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
name: Other
2-
description: Use this for any other issues. Please do NOT create blank issues
3-
title: "[OTHER]: <description>"
4-
labels: ["awaiting triage"]
5-
body:
6-
- type: markdown
7-
attributes:
8-
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
9-
10-
- type: checkboxes
11-
attributes:
12-
label: I have searched through the issues and didn't find my problem.
13-
options:
14-
- label: Confirm
15-
required: true
16-
17-
- type: textarea
18-
id: issuedescription
19-
attributes:
20-
label: What would you like to share?
21-
description: Provide a clear and concise explanation of your issue.
22-
validations:
23-
required: true
24-
25-
- type: textarea
26-
id: extrainfo
27-
attributes:
28-
label: Additional information
29-
description: Is there anything else we should know about this issue?
1+
name: Other
2+
description: Use this for any other issues. Please do NOT create blank issues
3+
title: "[OTHER]: description"
4+
labels: ["awaiting triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
9+
10+
- type: checkboxes
11+
attributes:
12+
label: I have searched through the issues and didn't find my problem.
13+
options:
14+
- label: Confirm
15+
required: true
16+
17+
- type: textarea
18+
id: issuedescription
19+
attributes:
20+
label: What would you like to share?
21+
description: Provide a clear and concise explanation of your issue.
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: extrainfo
27+
attributes:
28+
label: Additional information
29+
description: Is there anything else we should know about this issue?

0 commit comments

Comments
 (0)