mirror of
https://github.com/Templarian/MaterialDesign.git
synced 2026-02-20 01:41:26 +01:00
Convert to GitHub issue forms
This commit is contained in:
BIN
.github/.DS_Store
vendored
Normal file
BIN
.github/.DS_Store
vendored
Normal file
Binary file not shown.
BIN
.github/ISSUE_TEMPLATE/.DS_Store
vendored
Normal file
BIN
.github/ISSUE_TEMPLATE/.DS_Store
vendored
Normal file
Binary file not shown.
26
.github/ISSUE_TEMPLATE/1_icon_request.md
vendored
26
.github/ISSUE_TEMPLATE/1_icon_request.md
vendored
@@ -1,26 +0,0 @@
|
||||
---
|
||||
name: Request an Icon 💡
|
||||
about: Request an icon for the team to add
|
||||
title: ''
|
||||
labels: Icon Request
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
We are no longer accepting brand icons. Learn more: http://dev.materialdesignicons.com/roadmap/brand-icons
|
||||
-->
|
||||
|
||||
I have:
|
||||
|
||||
- [ ] [Searched all issues](https://github.com/Templarian/MaterialDesign/issues) to make sure there isn't a request for this icon.
|
||||
- [ ] [Searched the current library](https://materialdesignicons.com/) to make sure the icon doesn't exist.
|
||||
- [ ] Only requested a single icon (or a few near-identical ones) in this issue.
|
||||
|
||||
## Usage
|
||||
|
||||
Provide some context of how your icon could be used.
|
||||
|
||||
## Examples
|
||||
|
||||
Include any example images so we know what the icon should look like.
|
||||
|
||||
41
.github/ISSUE_TEMPLATE/1_icon_request.yml
vendored
Normal file
41
.github/ISSUE_TEMPLATE/1_icon_request.yml
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
name: Request a New Icon 💡
|
||||
description: Request a new icon to be added.
|
||||
labels: [Icon Request]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
This issue form is for requesting *new* icons for addition only!
|
||||
|
||||
Please note: [**We are no longer accepting new brand icons into MDI.**][1]
|
||||
|
||||
We recommend checking out [SimpleIcons][2]. SimpleIcons is a library specific to brand and product icons. If they do not currently have your requested icon, [you can request it on their GitHub page][3].
|
||||
|
||||
[1]: http://dev.materialdesignicons.com/roadmap/brand-icons
|
||||
[2]: https://simpleicons.org/
|
||||
[3]: https://github.com/simple-icons/simple-icons/issues
|
||||
- type: checkboxes
|
||||
id: acknowledgements
|
||||
attributes:
|
||||
label: "Before submitting a new icon request, please confirm the following:"
|
||||
options:
|
||||
- label: I have [searched all issues](https://github.com/Templarian/MaterialDesign/issues) to make sure there isn't a request for this icon.
|
||||
required: true
|
||||
- label: I have [searched the current library](https://materialdesignicons.com/) to make sure the icon doesn't already exist.
|
||||
required: true
|
||||
- label: I only intend to request a single icon (or a few near-identical ones) in this issue.
|
||||
required: true
|
||||
- type: textarea
|
||||
id: usage
|
||||
attributes:
|
||||
label: Usage
|
||||
description: Please provide some context of how this new icon could be used.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: examples
|
||||
attributes:
|
||||
label: Examples
|
||||
description: Please upload or provide links to images that exemplify this request. This gives us a better understanding of what you are requesting.
|
||||
validations:
|
||||
required: true
|
||||
26
.github/ISSUE_TEMPLATE/2_contribution.md
vendored
26
.github/ISSUE_TEMPLATE/2_contribution.md
vendored
@@ -1,26 +0,0 @@
|
||||
---
|
||||
name: Contribute an Icon ➕
|
||||
about: Get your icon into MDI.
|
||||
title: ''
|
||||
labels: Icon Request, Contribution
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
We are no longer accepting brand icons. Learn more: http://dev.materialdesignicons.com/roadmap/brand-icons
|
||||
-->
|
||||
|
||||
I have:
|
||||
|
||||
- [ ] [Searched the current library](https://materialdesignicons.com/) to make sure the icon doesn't exist.
|
||||
- [ ] Searched open issues to make sure there isn't a request for this icon.
|
||||
- [ ] Followed the [material guidelines](https://material.io/design/iconography/system-icons.html).
|
||||
|
||||
|
||||
## Preview
|
||||
|
||||
Paste a preview of your icon here. You can generate one using our [preview generator](http://dev.materialdesignicons.com/contribute/github).
|
||||
|
||||
## Zip Download
|
||||
|
||||
Drag or paste a zip folder containing your icon as a minimal SVG file. We just need the SVG tag with the viewbox and a single path element.
|
||||
43
.github/ISSUE_TEMPLATE/2_contribution.yml
vendored
Normal file
43
.github/ISSUE_TEMPLATE/2_contribution.yml
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
name: Contribute an Icon ➕
|
||||
description: Contribute a new icon to the library.
|
||||
labels: [Icon Request, Contribution]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
This issue form is for submitting new icon *contributions* only!
|
||||
|
||||
Please note: [**We are no longer accepting new brand icons into MDI.**][1]
|
||||
|
||||
We recommend checking out [SimpleIcons][2]. SimpleIcons is a library specific to brand and product icons. If they do not currently have your requested icon, [you can request it on their GitHub page][3].
|
||||
|
||||
[1]: http://dev.materialdesignicons.com/roadmap/brand-icons
|
||||
[2]: https://simpleicons.org/
|
||||
[3]: https://github.com/simple-icons/simple-icons/issues
|
||||
- type: checkboxes
|
||||
id: acknowledgements
|
||||
attributes:
|
||||
label: "Before submitting a new icon request, please confirm the following:"
|
||||
options:
|
||||
- label: I have [searched all issues](https://github.com/Templarian/MaterialDesign/issues) to make sure there isn't a request for this icon.
|
||||
required: true
|
||||
- label: I have [searched the current library](https://materialdesignicons.com/) to make sure the icon doesn't already exist.
|
||||
required: true
|
||||
- label: I have followed the [Material guidelines](https://material.io/design/iconography/system-icons.html) for system icons.
|
||||
required: true
|
||||
- type: textarea
|
||||
id: preview
|
||||
attributes:
|
||||
label: Preview
|
||||
description: Generate a preview of your icon using our [preview generator](http://dev.materialdesignicons.com/contribute/github). Your icon *must* be combined down to a single path to generate a preview.
|
||||
placeholder: Paste the generated preview of your icon here.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: source
|
||||
attributes:
|
||||
label: Icon Source
|
||||
description: ZIP the SVG source files for your icon(s) and upload it here. Your SVGs should only contain the single path used to generate your preview.
|
||||
placeholder: Upload your ZIP file here.
|
||||
validations:
|
||||
required: true
|
||||
14
.github/ISSUE_TEMPLATE/3_bug_report.md
vendored
14
.github/ISSUE_TEMPLATE/3_bug_report.md
vendored
@@ -1,14 +0,0 @@
|
||||
---
|
||||
name: Report a Bug 🐛
|
||||
about: Report an issue with an icon.
|
||||
title: ''
|
||||
labels: Bug
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
>> Make sure you searched opened issues! <<
|
||||
|
||||
If an icon is on the site it does not mean it has
|
||||
been released. https://materialdesignicons.com/history
|
||||
-->
|
||||
34
.github/ISSUE_TEMPLATE/3_bug_report.yml
vendored
Normal file
34
.github/ISSUE_TEMPLATE/3_bug_report.yml
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
name: Report a Bug 🐛
|
||||
description: Report an issue with the website, an icon, or one of our first-party libraries.
|
||||
labels: [Bug]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
*Make sure you [searched open issues](https://github.com/Templarian/MaterialDesign/issues) before submitting your bug report!*
|
||||
|
||||
If you see an icon on the site, but it is not in the latest release, *this is not a bug*.
|
||||
When new icons are added the library, they will immediately show on the website.
|
||||
However, a new release must happen before they will be available in our packages.
|
||||
See our [history log](https://materialdesignicons.com/history) for more information.
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: Where are you experiencing this bug?
|
||||
options:
|
||||
- materialdesignicons.com
|
||||
- A specific icon glyph
|
||||
- "@mdi/font"
|
||||
- "@mdi/js"
|
||||
- "@mdi/svg"
|
||||
- Another MDI package
|
||||
- Somewhere else
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: bug
|
||||
attributes:
|
||||
label: Bug Details
|
||||
description: Please describe the issue you are experiencing.
|
||||
validations:
|
||||
required: true
|
||||
14
.github/ISSUE_TEMPLATE/4_alias.md
vendored
14
.github/ISSUE_TEMPLATE/4_alias.md
vendored
@@ -1,14 +0,0 @@
|
||||
---
|
||||
name: Suggest an Icon Alias 🔃
|
||||
about: Make it easier to find the icons you need by suggesting alternative names.
|
||||
title: ''
|
||||
labels: Alias
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
>> Make sure you searched opened issues! <<
|
||||
|
||||
If an icon is on the site it does not mean it has
|
||||
been released. https://materialdesignicons.com/history
|
||||
-->
|
||||
26
.github/ISSUE_TEMPLATE/4_alias.yml
vendored
Normal file
26
.github/ISSUE_TEMPLATE/4_alias.yml
vendored
Normal file
@@ -0,0 +1,26 @@
|
||||
name: Suggest an Icon Alias 🔃
|
||||
description: Make it easier to find the icons you need by suggesting alternative names.
|
||||
labels: [Alias]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
*Make sure you [searched open issues](https://github.com/Templarian/MaterialDesign/issues) before submitting your bug report!*
|
||||
|
||||
Icon aliases are provide different names the help yourself and others find the icons you are looking for.
|
||||
Aliases *do not* provide you a different way to call a specific icon in your code.
|
||||
|
||||
For example, `account` has an alias of `user`. You can search for "user" on <materialdesignicons.com>, but you must use `account` when refering to the icon in your code.
|
||||
- type: input
|
||||
id: icon_name
|
||||
attributes:
|
||||
label: What icon would you like to alias?
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: alias
|
||||
attributes:
|
||||
label: What alias(es) should be added to the above icon?
|
||||
description: Provide multiple aliases with a comma-separated list.
|
||||
validations:
|
||||
required: true
|
||||
13
.github/ISSUE_TEMPLATE/5_question.md
vendored
13
.github/ISSUE_TEMPLATE/5_question.md
vendored
@@ -1,13 +0,0 @@
|
||||
---
|
||||
name: Ask a Question ❓
|
||||
about: Unlike other repos, we're fine with questions.
|
||||
title: ''
|
||||
labels: Question
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Please make sure it is relevant to the icon pack
|
||||
and not too specific to a Framework/Library.
|
||||
-->
|
||||
|
||||
14
.github/ISSUE_TEMPLATE/5_tag.md
vendored
14
.github/ISSUE_TEMPLATE/5_tag.md
vendored
@@ -1,14 +0,0 @@
|
||||
---
|
||||
name: Suggest a Tag 🏷
|
||||
about: Suggest a tag for an existing icon or a new tag entirely.
|
||||
title: ''
|
||||
labels: Tag
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
>> Make sure you searched opened issues! <<
|
||||
|
||||
Tags work like categories for icons. Multiple tags
|
||||
may apply for a single icon.
|
||||
-->
|
||||
29
.github/ISSUE_TEMPLATE/5_tag.yml
vendored
Normal file
29
.github/ISSUE_TEMPLATE/5_tag.yml
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
name: Suggest a Tag 🏷
|
||||
description: Suggest a tag for an existing icon (or a new tag entirely).
|
||||
labels: [Tag]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
*Make sure you [searched open issues](https://github.com/Templarian/MaterialDesign/issues) before submitting your bug report!*
|
||||
|
||||
Tags work like categories for icons and assist users of <materialdesignicons.com> with a way to narrow their search while browsing for icons to use. Multiple tags may apply for a single icon.
|
||||
- type: input
|
||||
id: icon_name
|
||||
attributes:
|
||||
label: What icon(s) would you like to suggest new tags for?
|
||||
description: Provide multiple icons to tag with a comma-separated list.
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: tag
|
||||
attributes:
|
||||
label: What tag(s) should be added to the above icon(s)?
|
||||
description: Provide multiple tags with a comma-separated list.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: more_info
|
||||
attributes:
|
||||
label: Did you suggest a new tag above?
|
||||
description: If you suggested a tag that does not yet exist, please give us some rationale on why the tag warrants addition.
|
||||
13
.github/ISSUE_TEMPLATE/6_doc_guide_request.md
vendored
13
.github/ISSUE_TEMPLATE/6_doc_guide_request.md
vendored
@@ -1,13 +0,0 @@
|
||||
---
|
||||
name: Request Documentation or Guide 📃
|
||||
about: Request documentation for a framework or how to guide
|
||||
title: ''
|
||||
labels: Documentation
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Please make sure your request is relevant to the icon pack
|
||||
and is not already covered in an existing doc / guide
|
||||
-->
|
||||
|
||||
14
.github/ISSUE_TEMPLATE/6_question.yml
vendored
Normal file
14
.github/ISSUE_TEMPLATE/6_question.yml
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
name: Ask a Question ❓
|
||||
description: Unlike other repos, we're fine with questions.
|
||||
labels: [Question]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
*Note:* Please make sure it is relevant to the icon pack and not too specific to a Framework/Library.
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: What is your question?
|
||||
validations:
|
||||
required: true
|
||||
14
.github/ISSUE_TEMPLATE/7_doc_guide_request.yml
vendored
Normal file
14
.github/ISSUE_TEMPLATE/7_doc_guide_request.yml
vendored
Normal file
@@ -0,0 +1,14 @@
|
||||
name: Request Documentation or Guide 📃
|
||||
description: Request a new how-to guide or documentation for a specific framework.
|
||||
labels: [Documentation]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
*Note:* Please make sure your request is relevant to the icon pack and is not already covered in existing documentation.
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: What new documentation or how-to guide would you like to see?
|
||||
validations:
|
||||
required: true
|
||||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -1 +1 @@
|
||||
blank_issues_enabled: false
|
||||
blank_issues_enabled: false
|
||||
Reference in New Issue
Block a user