mirror of
https://github.com/lucide-icons/lucide.git
synced 2025-12-29 02:27:12 +01:00
64 lines
3.1 KiB
Markdown
64 lines
3.1 KiB
Markdown
|
||
# Contribution Guidelines
|
||
|
||
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
|
||
|
||
The following is a set of guidelines for contributing to Lucide. Feel free to propose changes to this document in a pull request.
|
||
|
||
## Pull Requests
|
||
|
||
Feel free to open a pull-request to contribute to this project.
|
||
|
||
**Working on your first Pull Request?** You can learn how from this *free* series
|
||
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
|
||
|
||
Guidelines for pull requests:
|
||
|
||
- __Make your commit messages as descriptive as possible.__ Include as much information as you can. Explain anything that the file diffs themselves won’t make apparent.
|
||
- __Document your pull request__. Explain your fix, link to the relevant issue, add screenshots when adding new icons.
|
||
- __Make sure the target of your pull request is the relevant branch__. Most of bugfix or new feature should go to the `master` branch.
|
||
- __Include only related work__. If your pull request has unrelated commit, it won't be accepted.
|
||
|
||
### Pull Requests Including Icons
|
||
|
||
#### Guidelines
|
||
|
||
Please make sure you follow the icon guidelines, that should be followed to keep quality and consistency when making icons for Lucide.
|
||
|
||
Read it here: [ICON_GUIDELINES](docs/ICON_DESIGN_GUIDE.md).
|
||
|
||
### Templates
|
||
|
||
Here you can find templates and instructions on how to implement the guidelines with different programs.
|
||
|
||
#### Adobe Illustrator
|
||
|
||
`Template`: You can find a template for Adobe Illustrator under `/docs/templates/illustrator-template.ai`.
|
||
`Instructions`: You can find the [Illustrator Guide](/docs/ILLUSTRATOR_GUIDE.md) and how to work with the template in `/docs/ILLUSTRATOR_GUIDE.md`.
|
||
|
||
#### Inkscape
|
||
|
||
`Template`: None
|
||
`Instructions`: You can find the [Inkscape Guide](/docs/INKSCAPE_GUIDE.md) and how to set up Inkscape under `/docs/INKSCAPE_GUIDE.md`.
|
||
|
||
#### Figma
|
||
`Template`: None
|
||
`Instructions`: You can find the [Figma Guide](/docs/FIGMA_GUIDE.md) and how to set up Figma under `/docs/FIGMA_GUIDE.md`.
|
||
|
||
#### Submitting Mulitple Icons
|
||
|
||
If you want submit multiple icons, please separate the icons and group them. That makes reviewing the icons easier and keep the thread clean and scoped.
|
||
So don't submit multiple icons in one PR that have noting to do with each other.
|
||
So for example don't create one PR with icons: `arrow-up`, `bicycle`, `arrow-down`.
|
||
Seperate them by two PRs; 'pr-01' `arrow`, `arrow-down` and 'pr-02' `bicycle`.
|
||
|
||
## Icon Requests
|
||
|
||
Before creating an icon request, please search to see if someone has requested the icon already. If there is an open request, please add a :+1:.
|
||
|
||
If the icon has not already been requested, [create an issue](https://github.com/lucide-icons/lucide/issues/new?title=Icon%20Request:) with a title of `Icon request: <icon name>` and add as much information as possible.
|
||
|
||
## Icon Requests from Feather
|
||
|
||
If you are a designer who wants to contribute to Lucide but you don't know what icons to work on, then have a look at the Requests from Feather. All open, unfinished and valid requests can be found in [Feather Icon Requests](https://github.com/lucide-icons/lucide/issues/119).
|