👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Lucide. Feel free to propose changes to this document in a pull request.
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
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.
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
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
.
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 👍.
If the icon has not already been requested, create an issue with a title of Icon request: <icon name>
and add as much information as possible.
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.