Skip to content

Improve the issue templates #1515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
name: Bug Report
description: Report a bug/issue that you found in the SVGs, CSS files, or any other bug you encounter.
title: '[BUG]: <bug name>'
labels: [bug]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
- type: checkboxes
attributes:
label: I have searched through the issues and didn't find my problem.
options:
- label: Confirm
required: true
- type: textarea
id: description
attributes:
label: Bug description
description: Short description of the bug. Provide images/code if applicable.
validations:
required: true
- type: textarea
id: howtoreplicate
attributes:
label: Possible fixes or solutions
description: List any possible fixes/suggestions that you have in mind that could solve this issue.
validations:
required: true
- type: textarea
id: extrainformation
attributes:
label: Additional information
description: Is there anything else we should know about this bug?
name: Bug Report
description: Report a bug/issue that you found in the SVGs, CSS files, or any other bug you encounter.
title: '[BUG]: bug name'
labels: [bug]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."

- type: checkboxes
attributes:
label: I have searched through the issues and didn't find my problem.
options:
- label: Confirm
required: true

- type: textarea
id: description
attributes:
label: Bug description
description: Short description of the bug. Provide images/code if applicable.
validations:
required: true

- type: textarea
id: howtoreplicate
attributes:
label: Possible fixes or solutions
description: List any possible fixes/suggestions that you have in mind that could solve this issue.
validations:
required: true

- type: textarea
id: extrainformation
attributes:
label: Additional information
description: Is there anything else we should know about this bug?
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ blank_issues_enabled: false
contact_links:
- name: Discord community
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 changes: 43 additions & 43 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
name: Feature Request
description: Requesting a new feature or changes to an existing feature
title: '[FEATURE REQUEST]: <feature name>'
labels: [enhancement]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
- type: checkboxes
attributes:
label: I have searched through the issues and didn't find my problem.
options:
- label: Confirm
required: true
- type: textarea
id: description
attributes:
label: Description
description: Write down a detailed description of the feature.
validations:
required: true
- type: textarea
id: context
attributes:
label: Context
description: Why is this change important to you? How would you use it? How can it benefit other users?
validations:
required: true
- type: textarea
id: possiblesolution
attributes:
label: Possible Solution
description: If you have an idea, please tell us what might solve the above problem and the benefits it provides.
- type: textarea
id: extrainformation
attributes:
label: Additional information
description: Is there anything else we should know about this feature request?
name: Feature Request
description: Requesting a new feature or changes to an existing feature
title: '[FEATURE REQUEST]: feature name'
labels: [enhancement]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."

- type: checkboxes
attributes:
label: "I have searched through the issues and didn't find my problem."
options:
- label: Confirm
required: true

- type: textarea
id: description
attributes:
label: Description
description: Write down a detailed description of the feature.
validations:
required: true

- type: textarea
id: context
attributes:
label: Context
description: Why is this change important to you? How would you use it? How can it benefit other users?
validations:
required: true

- type: textarea
id: possiblesolution
attributes:
label: Possible Solution
description: If you have an idea, please tell us what might solve the above problem and the benefits it provides.

- type: textarea
id: extrainformation
attributes:
label: Additional information
description: Is there anything else we should know about this feature request?
97 changes: 60 additions & 37 deletions .github/ISSUE_TEMPLATE/icon_request.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,60 @@
name: Icon Request
description: Request a new icon, or changes to an existing icon
title: '[ICON REQUEST]: <icon name>'
labels: ["request:icon"]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."

- type: checkboxes
attributes:
label: I have searched through the issues and didn't find my problem.
options:
- label: Confirm
required: true

- type: input
id: about
attributes:
label: About the icon
description: Short description of why you think this icon belongs in our project.
validations:
required: true

- type: textarea
id: links
attributes:
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.).
validations:
required: true

- type: textarea
id: extrainformation
attributes:
label: Additional information
description: Is there anything else we should know about this icon?
name: Icon Request
description: Request a new icon, or changes to an existing icon
title: '[ICON REQUEST]: icon name'
labels: ["request:icon"]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."

- type: checkboxes
attributes:
label: I have searched through the issues and didn't find my problem.
options:
- label: Confirm
required: true

- type: input
id: about
attributes:
label: About the icon
description: Short description of why you think this icon belongs in our project.
validations:
required: true

- type: textarea
id: links
attributes:
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.).
validations:
required: true

- type: textarea
id: icons
attributes:
label: Icon links and previews
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 changes: 29 additions & 29 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
name: Other
description: Use this for any other issues. Please do NOT create blank issues
title: "[OTHER]: <description>"
labels: ["awaiting triage"]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."
- type: checkboxes
attributes:
label: I have searched through the issues and didn't find my problem.
options:
- label: Confirm
required: true
- type: textarea
id: issuedescription
attributes:
label: What would you like to share?
description: Provide a clear and concise explanation of your issue.
validations:
required: true
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this issue?
name: Other
description: Use this for any other issues. Please do NOT create blank issues
title: "[OTHER]: description"
labels: ["awaiting triage"]
body:
- type: markdown
attributes:
value: "## Before you continue, please search our open/closed issues to see if a similar issue has been addressed."

- type: checkboxes
attributes:
label: I have searched through the issues and didn't find my problem.
options:
- label: Confirm
required: true

- type: textarea
id: issuedescription
attributes:
label: What would you like to share?
description: Provide a clear and concise explanation of your issue.
validations:
required: true

- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this issue?