diff --git a/.github/ISSUE_TEMPLATE/icon_removal.yml b/.github/ISSUE_TEMPLATE/icon_removal.yml new file mode 100644 index 000000000..ec93af125 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/icon_removal.yml @@ -0,0 +1,35 @@ +name: Icon removal +description: Report an icon for removal +title: "Remove: " +labels: [removal request] + +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 `removal request` or `breaking change` label][removal-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. + + + [removal-issues]: https://github.com/simple-icons/simple-icons/issues?q=is%3Aissue+label%3A%22removal+request%22%2C%22breaking+change%22+is%3Aopen+ + + - type: input + attributes: + label: Brand Name + placeholder: "Example: Simple Icons" + validations: + required: true + + - type: textarea + attributes: + label: Reason for Removal + description: | + - If the brand no longer exists, include a link supporting that claim. + - If the brand should be removed for another reason, explain why. + placeholder: >- + Example: [this blogpost](https://example.com) announced the brand has been + discontinued... + validations: + required: true diff --git a/DISCLAIMER.md b/DISCLAIMER.md index f8e4a12d5..45eb42b73 100644 --- a/DISCLAIMER.md +++ b/DISCLAIMER.md @@ -4,10 +4,10 @@ Simple Icons asks that its users read this disclaimer fully before including an ## Table of Contents -* [Licenses, Copyrights & Trademarks](#licenses-copyrights--trademarks) -* [Brand Guidelines](#brand-guidelines) -* [Update of Brands](#update-of-brands) -* [Removal of Brands](#removal-of-brands) +- [Licenses, Copyrights & Trademarks](#licenses-copyrights--trademarks) +- [Brand Guidelines](#brand-guidelines) +- [Update of Brands](#update-of-brands) +- [Removal of Brands](#removal-of-brands) ## Licenses, Copyrights & Trademarks @@ -19,7 +19,7 @@ Simple Icons provides data on the license under which icons are available. We as The license under which an icon is available can be found in the icon's entry in the JSON data file in the NPM and Packagist packages, or through the license link on the icon's card on [the Simple Icons website]. -As we rely largely on our community to help us keep Simple Icons up-to-date, the license data for an icon may be outdated. If you find that the license data provided is outdated, please [submit an issue] to [the Simple Icons GitHub repository]. +As we rely largely on our community to help us keep Simple Icons up-to-date, the license data for an icon may be outdated. If you find that the license data provided is outdated, please [submit an issue][icon-outdated-issues] to [the Simple Icons GitHub repository]. If an icon includes a registered trademark (`®`) or trademark symbol (`™`) the recommendations outlined in [the Simple Icons Contributing Guidelines] are followed to decide whether to include the symbol or not. @@ -33,18 +33,19 @@ Simple Icons provides a link to a brand's _branding guidelines_ (or similar) if The brand guidelines can be found in the icon's entry in the JSON data file in the NPM and Packagist packages, or through the "Brand Guidelines" link on the icon's card on [the Simple Icons website]. -As we rely largely on our community to help us keep Simple Icons up-to-date, the guidelines link for a brand may be outdated. If you find that the guidelines are outdated, please [submit an issue] to [the Simple Icons GitHub repository]. +As we rely largely on our community to help us keep Simple Icons up-to-date, the guidelines link for a brand may be outdated. If you find that the guidelines are outdated, please [submit an issue][icon-outdated-issues] to [the Simple Icons GitHub repository]. ## Update of Brands -Should a brand wish for their icon or data to be updated, please [submit an issue] to [the Simple Icons GitHub repository]. In the issue, please explain your affiliation with the company and reasons for the update. We generally release updates once a week, but can make exceptions for immediate updates of brands. +Should a brand wish for their icon or data to be updated, please [submit an issue][icon-outdated-issues] to [the Simple Icons GitHub repository]. In the issue, please explain your affiliation with the company and reasons for the update. We generally release updates once a week, but can make exceptions for immediate updates of brands. ## Removal of Brands -Should a brand wish for their icon to be removed from the package, contact `removals at simpleicons dot org` explaining your affiliation with the company, and reasons for removal. Alternatively, it is also possible to [submit an issue] on [the Simple Icons GitHub repository] with the same information. We generally remove icons that no longer [meet our criteria] twice a year in our major releases - but can occasionally make exceptions for immediate removal of brands. +Should a brand wish for their icon to be removed from the package, contact `removals at simpleicons dot org` explaining your affiliation with the company, and reasons for removal. Alternatively, it is also possible to [submit an issue][removal-issues] on [the Simple Icons GitHub repository] with the same information. We generally remove icons that no longer [meet our criteria] twice a year in our major releases - but can occasionally make exceptions for immediate removal of brands. [meet our criteria]: https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md#requesting-an-icon -[submit an issue]: https://github.com/simple-icons/simple-icons/issues/new?labels=icon+outdated&template=icon_update.md -[the Simple Icons Contributing Guidelines]: https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md#icon-guidelines -[the Simple Icons GitHub repository]: https://github.com/simple-icons/simple-icons -[the Simple Icons website]: https://simpleicons.org/ +[icon-outdated-issues]: https://github.com/simple-icons/simple-icons/issues/new?assignees=&labels=icon+outdated&template=icon_update.yml&title=Update%3A+ +[removal-issues]: https://github.com/simple-icons/simple-icons/issues/new?assignees=&labels=removal+request&template=icon_removal.yml&title=Remove%3A+ +[the simple icons contributing guidelines]: https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md#icon-guidelines +[the simple icons github repository]: https://github.com/simple-icons/simple-icons +[the simple icons website]: https://simpleicons.org/