mirror of
https://github.com/konpa/devicon.git
synced 2025-08-10 16:45:54 +02:00
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 <halfpacho@gmail.com> * Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: David Leal <halfpacho@gmail.com> * Update .github/ISSUE_TEMPLATE/config.yml * fix indenting --------- Co-authored-by: David Leal <halfpacho@gmail.com>
This commit is contained in:
Jørgen Kalsnes Hagen
committed by
GitHub
GitHub
parent
f5fa2eca94
commit
80aeaf824e
74
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
74
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@@ -1,37 +1,37 @@
|
|||||||
name: Bug Report
|
name: Bug Report
|
||||||
description: Report a bug/issue that you found in the SVGs, CSS files, or any other bug you encounter.
|
description: Report a bug/issue that you found in the SVGs, CSS files, or any other bug you encounter.
|
||||||
title: '[BUG]: <bug name>'
|
title: '[BUG]: bug name'
|
||||||
labels: [bug]
|
labels: [bug]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
|
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
attributes:
|
attributes:
|
||||||
label: I have searched through the issues and didn't find my problem.
|
label: I have searched through the issues and didn't find my problem.
|
||||||
options:
|
options:
|
||||||
- label: Confirm
|
- label: Confirm
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: Bug description
|
label: Bug description
|
||||||
description: Short description of the bug. Provide images/code if applicable.
|
description: Short description of the bug. Provide images/code if applicable.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: howtoreplicate
|
id: howtoreplicate
|
||||||
attributes:
|
attributes:
|
||||||
label: Possible fixes or solutions
|
label: Possible fixes or solutions
|
||||||
description: List any possible fixes/suggestions that you have in mind that could solve this issue.
|
description: List any possible fixes/suggestions that you have in mind that could solve this issue.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: extrainformation
|
id: extrainformation
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional information
|
label: Additional information
|
||||||
description: Is there anything else we should know about this bug?
|
description: Is there anything else we should know about this bug?
|
||||||
|
|||||||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -2,4 +2,4 @@ blank_issues_enabled: false
|
|||||||
contact_links:
|
contact_links:
|
||||||
- name: Discord community
|
- name: Discord community
|
||||||
url: https://discord.gg/hScy8KWACQ
|
url: https://discord.gg/hScy8KWACQ
|
||||||
about: Found any bug? Need help? Feel free to contact us via Discord.
|
about: Found a bug? Need help? Feel free to contact us via Discord.
|
||||||
|
|||||||
86
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
86
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
@@ -1,43 +1,43 @@
|
|||||||
name: Feature Request
|
name: Feature Request
|
||||||
description: Requesting a new feature or changes to an existing feature
|
description: Requesting a new feature or changes to an existing feature
|
||||||
title: '[FEATURE REQUEST]: <feature name>'
|
title: '[FEATURE REQUEST]: feature name'
|
||||||
labels: [enhancement]
|
labels: [enhancement]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
|
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
attributes:
|
attributes:
|
||||||
label: I have searched through the issues and didn't find my problem.
|
label: "I have searched through the issues and didn't find my problem."
|
||||||
options:
|
options:
|
||||||
- label: Confirm
|
- label: Confirm
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: Description
|
label: Description
|
||||||
description: Write down a detailed description of the feature.
|
description: Write down a detailed description of the feature.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: context
|
id: context
|
||||||
attributes:
|
attributes:
|
||||||
label: Context
|
label: Context
|
||||||
description: Why is this change important to you? How would you use it? How can it benefit other users?
|
description: Why is this change important to you? How would you use it? How can it benefit other users?
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: possiblesolution
|
id: possiblesolution
|
||||||
attributes:
|
attributes:
|
||||||
label: Possible Solution
|
label: Possible Solution
|
||||||
description: If you have an idea, please tell us what might solve the above problem and the benefits it provides.
|
description: If you have an idea, please tell us what might solve the above problem and the benefits it provides.
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: extrainformation
|
id: extrainformation
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional information
|
label: Additional information
|
||||||
description: Is there anything else we should know about this feature request?
|
description: Is there anything else we should know about this feature request?
|
||||||
|
|||||||
97
.github/ISSUE_TEMPLATE/icon_request.yml
vendored
97
.github/ISSUE_TEMPLATE/icon_request.yml
vendored
@@ -1,37 +1,60 @@
|
|||||||
name: Icon Request
|
name: Icon Request
|
||||||
description: Request a new icon, or changes to an existing icon
|
description: Request a new icon, or changes to an existing icon
|
||||||
title: '[ICON REQUEST]: <icon name>'
|
title: '[ICON REQUEST]: icon name'
|
||||||
labels: ["request:icon"]
|
labels: ["request:icon"]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
|
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
attributes:
|
attributes:
|
||||||
label: I have searched through the issues and didn't find my problem.
|
label: I have searched through the issues and didn't find my problem.
|
||||||
options:
|
options:
|
||||||
- label: Confirm
|
- label: Confirm
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: input
|
- type: input
|
||||||
id: about
|
id: about
|
||||||
attributes:
|
attributes:
|
||||||
label: About the icon
|
label: About the icon
|
||||||
description: Short description of why you think this icon belongs in our project.
|
description: Short description of why you think this icon belongs in our project.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: links
|
id: links
|
||||||
attributes:
|
attributes:
|
||||||
label: Links and sources
|
label: Links and sources
|
||||||
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.).
|
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.).
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: extrainformation
|
id: icons
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional information
|
label: Icon links and previews
|
||||||
description: Is there anything else we should know about this icon?
|
description: |
|
||||||
|
Provide previews and links to official icons (preferably SVG's).
|
||||||
|
*If there are no offical icons, or if you feel unofficial ones should be used instead, please add them here.*
|
||||||
|
|
||||||
|
Example:
|
||||||
|
```md
|
||||||
|
#### jule-original
|
||||||
|
<img alt="Git" width="100px" src="https://raw.githubusercontent.com/julelang/resources/6b1f4e68a8258435d87f29b9b2206b20a321f54e/jule.svg" ></img>
|
||||||
|
https://github.com/julelang/resources/blob/main/jule.svg
|
||||||
|
```
|
||||||
|
value: |
|
||||||
|
#### iconname-version-name
|
||||||
|
<img width="100px" src="previewable_link_to_icon" ></img>
|
||||||
|
link_to_icon
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: extrainformation
|
||||||
|
attributes:
|
||||||
|
label: Additional information
|
||||||
|
description: |
|
||||||
|
Is there anything else we should know about this icon?
|
||||||
|
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
|
||||||
|
|||||||
58
.github/ISSUE_TEMPLATE/other.yml
vendored
58
.github/ISSUE_TEMPLATE/other.yml
vendored
@@ -1,29 +1,29 @@
|
|||||||
name: Other
|
name: Other
|
||||||
description: Use this for any other issues. Please do NOT create blank issues
|
description: Use this for any other issues. Please do NOT create blank issues
|
||||||
title: "[OTHER]: <description>"
|
title: "[OTHER]: description"
|
||||||
labels: ["awaiting triage"]
|
labels: ["awaiting triage"]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
|
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
attributes:
|
attributes:
|
||||||
label: I have searched through the issues and didn't find my problem.
|
label: I have searched through the issues and didn't find my problem.
|
||||||
options:
|
options:
|
||||||
- label: Confirm
|
- label: Confirm
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: issuedescription
|
id: issuedescription
|
||||||
attributes:
|
attributes:
|
||||||
label: What would you like to share?
|
label: What would you like to share?
|
||||||
description: Provide a clear and concise explanation of your issue.
|
description: Provide a clear and concise explanation of your issue.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: extrainfo
|
id: extrainfo
|
||||||
attributes:
|
attributes:
|
||||||
label: Additional information
|
label: Additional information
|
||||||
description: Is there anything else we should know about this issue?
|
description: Is there anything else we should know about this issue?
|
||||||
|
|||||||
Reference in New Issue
Block a user