Compare commits

...

4 commits

Author SHA1 Message Date
Karsa
576a303de8
Apply suggestion from @ericfennis
Co-authored-by: Eric Fennis <eric.fennis@gmail.com>
2026-11-20 14:28:46 +01:00
Karsa
63b4bee625 feat(github): update links in icon request issue template checklist 2026-11-19 10:17:13 +01:00
Karsa
55a6b663f4 feat(github): also updated icon request issue template 2026-11-19 10:15:45 +01:00
Karsa
cfa0efd488 feat(docs): add icon eligibility guide & simplify PR template 2026-11-19 10:01:54 +01:00
5 changed files with 81 additions and 52 deletions

View file

@ -5,12 +5,21 @@ body:
- type: markdown
attributes:
value: |
Before submitting an icon request check if it has already been requested. If there is an open request, please add a 👍.
Before submitting, search [existing icons (including Lab)](https://lucide.dev/icons/?library=lab) and open and closed [icon requests](https://github.com/lucide-icons/lucide/issues?q=is%3Aissue+label%3A%22%F0%9F%99%8C+icon+request%22) and [icon PRs](https://github.com/lucide-icons/lucide/pulls?q=is%3Apr+label%3A%22%F0%9F%8E%A8+icon%22). If there is an open request, please add a 👍 instead.
> [!CAUTION]
> New brand logos are **not** allowed, see our official statement: https://github.com/lucide-icons/lucide/blob/main/BRAND_LOGOS_STATEMENT.md.
> Please review our [icon eligibility guidelines](https://lucide.dev/contribute/icons/eligibility). Lucide does not accept:
>
> Existing brand icons are being phased out. Consider using https://simpleicons.org, which offers purpose-built SVGs that are also on a 24×24px grid.
> - Brand icons or logos.
> - Hate symbols or discriminatory or dehumanizing imagery.
> - Religious imagery.
> - War- or violence-related imagery.
> - Political imagery.
> - Sexually explicit or graphic imagery.
> - Designs copied or traced from sources with unclear provenance or without permission compatible with [Lucide's license](https://lucide.dev/license). Giving credit alone does not grant permission to use a design.
> - Duplicates without a meaningful distinction, including near-identical concepts and purely decorative variations.
For more information on brand icons, see our [brand logo statement](https://lucide.dev/brand-logo-statement). Consider [Simple Icons](https://simpleicons.org) for brand logos on a 24×24px grid.
- type: input
id: name
attributes:
@ -22,7 +31,7 @@ body:
id: use-cases
attributes:
label: Use cases
description: Why do you need this icon? Include at least two real-life use cases per requested icon, avoiding generic descriptions like "it's a car icon".
description: Why do you need this icon? Include at least two real-life use cases per requested icon, avoiding generic descriptions like "it's a car icon". See our [use case guide](https://lucide.dev/contribute/icons/metadata-conventions/use-case-guide).
placeholder: e.g. I need a star icon to use in my rating system.
validations:
required: true
@ -39,13 +48,13 @@ body:
label: Checklist
description: Please review the following checklist before submitting your request.
options:
- label: I have searched if someone has submitted a similar issue before and there weren't any. (Please make sure to also search closed issues, as this issue might already have been resolved.)
- label: I have searched open and closed open and closed [icon requests](https://github.com/lucide-icons/lucide/issues?q=is%3Aissue+label%3A%22%F0%9F%99%8C+icon+request%22) and [icon PRs](https://github.com/lucide-icons/lucide/pulls?q=is%3Apr+label%3A%22%F0%9F%8E%A8+icon%22) and found no existing request for this icon.
required: true
- label: I have searched existing icons to make sure it does not already exist and I didn't find any.
- label: I have searched [existing icons (including Lab)](https://lucide.dev/icons/?library=lab) and confirmed that this icon does not already exist.
required: true
- label: I am not requesting a brand logo and the art is not protected by copyright, see more at https://github.com/lucide-icons/lucide/blob/main/BRAND_LOGOS_STATEMENT.md
- label: I'm not requesting brand icons, logos, or copyrighted, trademarked or otherwise licensed designs.
required: true
- label: I am not requesting an icon that includes religious, war/violence related, political imagery or hate symbols.
- label: I'm not requesting hateful or discriminatory symbols, religious or political imagery, violence, or sexually explicit or graphic content.
required: true
- label: I have provided appropriate use cases for the icon(s) requested.
required: true

View file

@ -1,5 +1,3 @@
<!-- Thank you for contributing! -->
<!--
PR Title Guidelines:
@ -11,51 +9,40 @@ Available types: fix, feat, perf, docs, style, refactor, test, chore, ci, build
Common scopes: icons, docs, studio, site, dev
-->
<!-- Insert `closes #issueNumber` here if merging this PR will resolve an existing issue -->
<!-- Insert `closes #issueNumber` below this line if merging this PR will resolve an existing issue or PR -->
## Description
<!-- Please insert your description here and provide info about the "what" this PR is contribution -->
<!-- What does this PR change, and why? -->
### Icon use case <!-- ONLY for new icons, remove this part if not icon PR -->
<!-- What is the purpose of this icon? For each icon added, please insert at least two real life use cases (the more the better). Text like "it's a car icon" is not accepted. -->
### Icon details
<!-- Only for new icons or substantial redesigns; otherwise remove this section. -->
### Alternative icon designs <!-- ONLY for new icons, remove this part if not icon PR -->
<!-- If you have any alternative icon designs, please attach them here. -->
**Alternative designs:**
<!-- Include any alternative designs, if available. -->
## Icon Design Checklist <!-- ONLY for new icons, remove this part if not icon PR -->
**Created by:**
<!-- Myself | created by @USERNAME in #ISSUE_NUMBER -->
### Concept <!-- ONLY for new icons -->
<!-- All of these requirements must be fulfilled. -->
<!-- IMPORTANT! Please read our official statement on brand logos in Lucide: -->
<!-- https://github.com/lucide-icons/lucide/blob/main/BRAND_LOGOS_STATEMENT.md -->
- [ ] I have provided valid use cases for each icon.
- [ ] I have [not added any brand or logo icon](https://github.com/lucide-icons/lucide/blob/main/BRAND_LOGOS_STATEMENT.md).
- [ ] I have not used any hate symbols.
- [ ] I have not included any religious, war/violence related or political imagery.
**Based on:**
<!-- List lucide icons -->
### Author, credits & license<!-- ONLY for new icons. -->
<!-- Please choose one of the following, and put an "x" next to it. -->
- [ ] The icons are solely my own creation.
- [ ] The icons were originally created in #<issueNumber> by @<githubUser>
- [ ] I've based them on the following Lucide icons: <!-- provide the list of icons -->
- [ ] I've based them on the following design: <!-- provide source URL and license permitting use -->
**Inspired by:**
<!-- List external designs -->
### Naming <!-- ONLY for new icons -->
<!-- All of these requirements must be fulfilled. -->
- [ ] I've read and followed the [naming conventions](https://lucide.dev/contribute/icon-design-guide#naming-conventions)
- [ ] I've named icons by what they are rather than their use case.
- [ ] I've provided meta JSON files in `icons/[iconName].json`.
## Before submitting
### Design <!-- ONLY for new icons -->
<!-- All of these requirements must be fulfilled. -->
- [ ] I've read and followed the applicable guides below and checked for existing PRs addressing the same change.
- [ ] I've read and followed the [icon design guidelines](https://lucide.dev/contribute/icon-design-guide)
- [ ] I've made sure that the icons don't [already exist](https://lucide.dev/icons), including the [Lab directory](https://github.com/lucide-icons/lucide/tree/main/lab).
- [ ] I've made sure that the icons look sharp on low DPI displays.
- [ ] I've made sure that the icons look consistent with the icon set in size, optical volume and density.
- [ ] I've made sure that the icons are visually centered.
- [ ] I've correctly optimized all icons to three points of precision.
**For all PRs:**
- [Contribution guide](https://lucide.dev/contribute/)
## Before Submitting <!-- For every PR! -->
<!-- All of these requirements must be fulfilled. -->
- [ ] I've read the [Contribution Guidelines](https://github.com/lucide-icons/lucide/blob/main/CONTRIBUTING.md).
- [ ] I've checked if there was an existing PR that solves the same issue.
**Only for new icons or substantial redesigns:**
- [Icon contribution guide](https://lucide.dev/contribute/icons/)
- [Icon eligibility](https://lucide.dev/contribute/icons/eligibility)
- [Design language](https://lucide.dev/contribute/icons/design-principles)
- [Design specification](https://lucide.dev/contribute/icons/specification)
- [Naming conventions](https://lucide.dev/contribute/icons/naming-conventions)
- [Metadata conventions](https://lucide.dev/contribute/icons/metadata-conventions/)
- [Use case guide](https://lucide.dev/contribute/icons/metadata-conventions/use-case-guide)
- [Tag guide](https://lucide.dev/contribute/icons/metadata-conventions/tag-guide)
- [SVG conventions](https://lucide.dev/contribute/icons/code-conventions)

View file

@ -14,10 +14,6 @@ export const resourcesSidebar = [
text: 'Code of conduct',
link: '/code-of-conduct',
},
{
text: 'Brand logo statement',
link: '/brand-logo-statement',
},
],
},
{
@ -55,6 +51,17 @@ export const resourcesSidebar = [
text: 'Getting started',
link: '/contribute/icons/',
},
{
text: 'Icon eligibility',
link: '/contribute/icons/eligibility',
desc: 'Check which icon concepts are suitable for Lucide before you start designing.',
items: [
{
text: 'Brand logo statement',
link: '/brand-logo-statement',
},
],
},
{
text: 'Design language',
link: '/contribute/icons/design-principles',

View file

@ -0,0 +1,24 @@
---
description: Check whether an icon is suitable for contribution to Lucide.
---
# Icon eligibility
Before designing a new icon or substantially redesigning an existing one, make sure the concept is suitable for Lucide.
## Excluded contributions
Lucide does not accept:
- Brand icons or logos. See our [brand logo statement](/brand-logo-statement) for the reasons behind this policy.
- Hate symbols or discriminatory or dehumanizing imagery.
- Religious imagery.
- War- or violence-related imagery.
- Political imagery.
- Sexually explicit or graphic imagery.
- Designs copied or traced from sources with unclear provenance or without permission compatible with [Lucide's license](/license). Giving credit alone does not grant permission to use a design.
- Duplicates without a meaningful distinction, including near-identical concepts and purely decorative variations.
## Check for existing icons
Before adding a new icon, search the [icon library (including Lab)](/icons/?library=lab) to make sure the icon does not already exist.

View file

@ -14,6 +14,8 @@ Every icon should feel like it belongs with the rest of Lucide.
This guide explains how to design and prepare icons for Lucide.
For new icons or substantial redesigns, start with [icon eligibility](./eligibility) to check the content restrictions and contribution requirements.
## What this guide covers
<OverviewLinkGrid>