mirror of
https://github.com/lucide-icons/lucide.git
synced 2025-12-28 23:06:46 +01:00
58 lines
2.8 KiB
Markdown
58 lines
2.8 KiB
Markdown
<!-- Thank you for contributing! -->
|
|
|
|
<!--
|
|
PR Title Guidelines:
|
|
|
|
Please use the format: <type>(<scope>): <short description>
|
|
|
|
Example: feat(icons): added `camera` icon
|
|
|
|
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 -->
|
|
## Description
|
|
<!-- Please insert your description here and provide info about the "what" this PR is contribution -->
|
|
|
|
### 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. -->
|
|
|
|
### 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. -->
|
|
|
|
## Icon Design Checklist <!-- ONLY for new icons, remove this part if not icon PR -->
|
|
|
|
### Concept <!-- ONLY for new icons -->
|
|
<!-- All of these requirements must be fulfilled. -->
|
|
- [ ] I have provided valid use cases for each icon.
|
|
- [ ] I have not added any a brand or logo icon.
|
|
- [ ] I have not used any hate symbols.
|
|
- [ ] I have not included any religious or political imagery.
|
|
|
|
### 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 -->
|
|
|
|
### Naming <!-- ONLY for new icons -->
|
|
<!-- All of these requirements must be fulfilled. -->
|
|
- [ ] I've read and followed the [naming conventions](https://lucide.dev/guide/design/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`.
|
|
|
|
### Design <!-- ONLY for new icons -->
|
|
<!-- All of these requirements must be fulfilled. -->
|
|
- [ ] I've read and followed the [icon design guidelines](https://lucide.dev/guide/design/icon-design-guide)
|
|
- [ ] 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.
|
|
|
|
## 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.
|