2022-08-28 20:12:09 +02:00
|
|
|
|
---
|
|
|
|
|
title: How to contribute
|
|
|
|
|
---
|
|
|
|
|
|
2021-05-23 09:46:48 +02:00
|
|
|
|
# How to contribute
|
|
|
|
|
|
2022-08-28 20:12:09 +02:00
|
|
|
|
✨ First off, thanks for taking the time to contribute! ✨
|
2021-05-23 09:46:48 +02:00
|
|
|
|
|
|
|
|
|
The following is a quick set of guidelines for contributing to Iconoir.
|
|
|
|
|
|
|
|
|
|
## Pull Requests
|
|
|
|
|
|
2022-08-28 20:12:09 +02:00
|
|
|
|
> **ℹ️ Note:** At the moment, to keep consistency, quality, and make the whole
|
|
|
|
|
> process time-efficient, we are not accepting pull requests containing icons. You can open an issue
|
|
|
|
|
> to request a new icon.
|
2021-05-23 09:46:48 +02:00
|
|
|
|
|
|
|
|
|
Pull requests for new features, bug fixes, etc. are often appreciated.
|
|
|
|
|
|
2022-08-28 20:12:09 +02:00
|
|
|
|
> 👉 We're looking for help with fonts and libraries.
|
2021-05-23 09:46:48 +02:00
|
|
|
|
|
|
|
|
|
Guidelines for pull requests:
|
2022-08-28 20:12:09 +02:00
|
|
|
|
|
|
|
|
|
> **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.
|
|
|
|
|
|
2022-08-28 20:16:41 +02:00
|
|
|
|
> **Target main.** Most of bugfixes or new features should go to the main branch.
|
2022-08-28 20:12:09 +02:00
|
|
|
|
|
|
|
|
|
> **Include only related work.** If your pull request has unrelated commits, it won't be accepted.
|
|
|
|
|
|
|
|
|
|
> **Packages and Libraries.** If you're adding or updating a package or React / Vue library, the
|
|
|
|
|
> target folder is `/packages/iconoir-[LIBRARY_NAME]`.
|
|
|
|
|
|
|
|
|
|
> **Fonts.** If you're adding or updating fonts, the target folder is `/fonts/`.
|
2021-05-23 09:46:48 +02:00
|
|
|
|
|
|
|
|
|
## Icon Requests
|
|
|
|
|
|
2022-08-28 20:12:09 +02:00
|
|
|
|
Before creating an icon request, please search to see if someone has requested the icon already. If
|
|
|
|
|
there is an open request, please upvote it.
|
2021-05-23 09:46:48 +02:00
|
|
|
|
|
2022-08-28 20:12:09 +02:00
|
|
|
|
If the icon has not already been requested, [create an
|
|
|
|
|
issue](https://github.com/iconoir-icons/iconoir/issues/new/choose) and add as much information as
|
|
|
|
|
possible. Follow the rules you see when opening a new bug report.
|
2021-05-23 09:46:48 +02:00
|
|
|
|
|
|
|
|
|
## Bug Reports
|
|
|
|
|
|
2022-08-28 20:12:09 +02:00
|
|
|
|
Before reporting an issue, please search to see if someone has filed a similar issue before. If
|
|
|
|
|
there is already an open issue, please upvote it and/or leave a comment with additional information.
|
2021-05-23 09:46:48 +02:00
|
|
|
|
Follow the rules you see when opening a new bug report.
|