diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 4ef638250..000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Documentation -about: Report problems and suggest ideas for the documentation -labels: docs ---- - - - - -### Kind of issue - - [ ] Improvement - - [ ] Mistake - - [ ] Other, namely: - -### Description - - - diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 000000000..3f100766d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,47 @@ +name: Documentation +description: Report problems and suggest ideas for the documentation +labels: [docs] + +body: + - type: markdown + attributes: + value: >- + Before opening a new issue, make sure it isn't covered by an existing issue. + Please search for [issues with the `docs` label][docs-issues] (including + closed issues) before you continue. + + + [docs-issues]: https://github.com/simple-icons/simple-icons/issues?q=is%3Aissue+label%3Adocs+is%3Aopen + + - type: dropdown + attributes: + label: Kind of Issue + description: >- + If your issue type is not here, select "other" and explain in the + "Description" field below. + options: [Improvement, Mistake, Other] + validations: + required: true + + - type: textarea + attributes: + label: Description + description: | + Include as much detail as possible, for example: + - A (perma)link to the docs in question + - Suggestions for how to change the docs + placeholder: "Example: The documentation doesn't cover my use case of the NPM package..." + validations: + required: true + + - type: dropdown + attributes: + label: Contributing + description: >- + This is an open source project and we welcome contributions. Do you want to + work on this issue? + options: + - "Yes" + - "No" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/icon_request.md b/.github/ISSUE_TEMPLATE/icon_request.md deleted file mode 100644 index dbef385ed..000000000 --- a/.github/ISSUE_TEMPLATE/icon_request.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: Icon request -about: Request a new icon for Simple Icons -labels: new icon ---- - - -**Brand Name:** -**Website:** -**Alexa rank:** - - -**Official resources for icon and color:** - - - diff --git a/.github/ISSUE_TEMPLATE/icon_request.yml b/.github/ISSUE_TEMPLATE/icon_request.yml new file mode 100644 index 000000000..36bd1db30 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/icon_request.yml @@ -0,0 +1,90 @@ +name: Icon request +description: Request a new icon for Simple Icons +title: "Request: " +labels: [new icon] + +body: + - type: markdown + attributes: + value: >- + We won't add non-brand icons or anything related to illegal services. If in + doubt, open an issue and we'll have a look. For more details see the + [Contributing Guidelines]. + + + Before opening a new issue, make sure it isn't covered by an existing issue. + Please search for [issues with the `new icon` label][new-icon-issues] + (including closed issues) before you continue. If you find one for the brand + you're requesting then leave a comment on it or add a reaction. + + + [contributing guidelines]: https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md + + [new-icon-issues]: https://github.com/simple-icons/simple-icons/issues?q=is%3Aissue+label%3A%22new+icon%22+is%3Aopen + + - type: input + attributes: + label: Brand Name + placeholder: "Example: Simple Icons" + validations: + required: true + + - type: input + attributes: + label: Website + description: >- + For non-web brands you can add a relevant link. You can put "None" if you don't + think there's a website. + placeholder: "Example: https://simpleicons.org" + validations: + required: true + + - type: textarea + attributes: + label: Popularity Metric + description: >- + Provide either an [Alexa rank] or the number of GitHub stars. If these are not + available or too low you can still open the issue. In this case, please + provide any information regarding the brand's popularity you think is + relevant. + + + [alexa rank]: https://www.alexa.com/siteinfo + placeholder: "Example: The Alexa rank is 249,089. See https://www.alexa.com/siteinfo/simpleicons.org" + validations: + required: true + + - type: textarea + attributes: + label: Official Resources for Icon and Color + description: >- + Media kits, brand guidelines, SVG files, etc. You can set + this to "None" if you are unable to find any resources. + placeholder: | + Example: + svg: https://github.com/simple-icons/simple-icons/blob/develop/icons/simpleicons.svg + color: `#111111`, from the website header + validations: + required: true + + - type: textarea + attributes: + label: Additional Comments + description: | + Is there anything else we should know about the brand? Remember that not everyone knows the brand as well as you do. For example: + - Are there multiple options for the logo and/or color? + - Is the icon released under a license? + - If you think the brand might not be accepted, why do you think it should be considered? + placeholder: "Example: There are two variants of this icon..." + + - type: dropdown + attributes: + label: Contributing + description: >- + This is an open source project and we welcome contributions. Do you want to + add this icon? + options: + - "Yes" + - "No" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/icon_update.md b/.github/ISSUE_TEMPLATE/icon_update.md deleted file mode 100644 index 938efff48..000000000 --- a/.github/ISSUE_TEMPLATE/icon_update.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: Icon update -about: Help us improve by reporting outdated icons -labels: icon outdated ---- - - - - - -**Brand Name:** -**Official resources for icon and color:** - diff --git a/.github/ISSUE_TEMPLATE/icon_update.yml b/.github/ISSUE_TEMPLATE/icon_update.yml new file mode 100644 index 000000000..bd4c55186 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/icon_update.yml @@ -0,0 +1,57 @@ +name: Icon update +description: Help us improve by reporting outdated icons +title: "Update: " +labels: [icon outdated] + +body: + - type: markdown + attributes: + value: >- + Before opening a new issue, make sure it isn't covered by an existing issue. + Please search for [issues with the `icon outdated` label][icon-outdated-issues] + (including closed issues) before you continue. If you find one for the brand + you're reporting then leave a comment on it or add a reaction. + + + [icon-outdated-issues]: https://github.com/simple-icons/simple-icons/issues?q=is%3Aissue+label%3A%22icon+outdated%22+is%3Aopen + + - type: input + attributes: + label: Brand Name + placeholder: "Example: Simple Icons" + validations: + required: true + + - type: textarea + attributes: + label: Official Resources for Icon and Color + description: >- + Media kits, brand guidelines, SVG files, etc. You can set + this to "None" if you are unable to find any resources. + placeholder: | + Example: + svg: https://github.com/simple-icons/simple-icons/blob/develop/icons/simpleicons.svg + color: `#111111`, from the website header + validations: + required: true + + - type: textarea + attributes: + label: Additional Comments + description: | + Is there anything else we should know about the brand? Remember that not everyone knows the brand as well as you do. For example: + - Are there multiple options for the logo and/or color? + - Is the icon released under a license? + placeholder: "Example: There are two variants of this icon..." + + - type: dropdown + attributes: + label: Contributing + description: >- + This is an open source project and we welcome contributions. Do you want to + update this icon? + options: + - "Yes" + - "No" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/package.md b/.github/ISSUE_TEMPLATE/package.md deleted file mode 100644 index 927ad7102..000000000 --- a/.github/ISSUE_TEMPLATE/package.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Packages -about: Report problems and suggest ideas for the packages -labels: package ---- - - - - -### Kind of issue - - [ ] Improvement - - [ ] Bug - - [ ] Other, namely: - -### This issue concerns - - [ ] The NPM Package - - [ ] The Packagist Package - -### Description - - - diff --git a/.github/ISSUE_TEMPLATE/package.yml b/.github/ISSUE_TEMPLATE/package.yml new file mode 100644 index 000000000..0b802eb51 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/package.yml @@ -0,0 +1,64 @@ +name: Packages +description: Report problems and suggest ideas for the packages +labels: [package] + +body: + - type: markdown + attributes: + value: >- + Before opening a new issue, make sure it isn't covered by an existing issue. + Please search for [issues with the `package` label][package-issues] (including + closed issues) before you continue. + + + [package-issues]: https://github.com/simple-icons/simple-icons/issues?q=is%3Aissue+label%3Apackage+is%3Aopen + + - type: dropdown + attributes: + label: Kind of Issue + description: >- + If your issue type is not here, select "other" and explain in the + "Description" field below. + options: [Bug, Feature, Performance, Other] + validations: + required: true + + - type: dropdown + attributes: + label: This issue concerns the... + options: [NPM package, Packagist package] + multiple: true + validations: + required: true + + - type: input + attributes: + label: Package Version + placeholder: "Example: 5.11.0" + validations: + required: true + + - type: textarea + attributes: + label: Other Software + description: >- + The software that you are using the package with (Node.js & NPM, PHP & Packagist, + Browser(s), other) and their versions. You can put "None" if you are unsure. + placeholder: | + Example: + Node.js v16 + Chrome 92.0.4515.159 (Official Build) (64-bit) + validations: + required: true + + - type: textarea + attributes: + label: Description + description: | + Anything relevant, for example: + - For bugs: "Steps to reproduce" and "Expected behavior" + - For feature requests: An example of a use case + - For performance: An example where performance is poor + placeholder: "Example: The NPM package does not work for my use case..." + validations: + required: true