34594af2bd
* Added the template and changed corresponding documentation Added the illustrator template and created (ILLUSTRATOR_GUIDE.md) oder changed (CONTRIBUTING.md) files. * fixed typo * split up template instruction docs for programs documentation concerning the templates and instrcutions is now separated in the documentation. * updated illustrator export documentation updated illustrator guide with the according options for exporting SVGs * updated image path image path should be correct now * matching filenames files names illustrator guide should match file name in /images * image in illustrator guide path correction image should work now * layout adjustments to illustrator guide layout should be pretty now * layout corrections second try
3.0 KiB
Contribution Guidelines
:+1:🎉 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.
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
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
masterbranch. - 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.
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 and how to work with the template in /docs/ILLUSTRATOR_GUIDE.md.
Inkscape
Template: None
Instructions: You can find the Inkscape Guide and how to set up Inkscape under /docs/INKSCAPE_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 👍.
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.
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.