Files

44 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

2020-06-08 16:39:52 +01:00
# Contribution Guidelines
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
2020-10-31 17:11:42 +01:00
The following is a set of guidelines for contributing to Lucide. Feel free to propose changes to this document in a pull request.
2020-06-08 16:39:52 +01:00
## Pull Requests
2020-06-25 10:13:59 +02:00
Feel free to open a pull-request to contribute to this project.
2020-06-08 16:39:52 +01:00
**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:
2021-04-11 01:55:11 +02:00
2020-06-08 16:39:52 +01:00
- __Make your commit messages as descriptive as possible.__ Include as much information as you can. Explain anything that the file diffs themselves wont 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.
2021-04-11 01:55:11 +02:00
### Pull Requests Including Icons
2020-12-02 14:46:42 +01:00
#### 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)
#### 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.
2021-04-11 01:55:11 +02:00
So don't submit multiple icons in one PR that have noting to do with each other.
2020-12-02 14:46:42 +01:00
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`.
2020-06-08 16:39:52 +01:00
## 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.
2020-10-31 17:11:42 +01:00
## Icon Requests from Feather
2021-04-11 01:55:11 +02:00
2020-10-31 17:11:42 +01:00
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).