diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..06bce33a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# How to contribute + +:sparkles: First off, thanks for taking the time to contribute! :sparkles: + +The following is a quick set of guidelines for contributing to Iconoir. + +## Pull Requests + +> :information_source: **Note:** At the moment we are not accepting pull requests containing _**icons**_. The best way to contribute an icon is to create an issue with a screenshot and link to an SVG of your icon. + +Pull requests for new features, bug fixes, etc. are often appreciated. + +:point_right: We're looking for help with fonts and libraries. + +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. +- __Target Master__. 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. +- __Packages and Libraries__. If you're adding or updating a package or React/Vue library the target folder is `/packages/[LIBRARY_NAME]`. +- __Fonts__. If you're adding or updating fonts the target folder is `/fonts/`. + +## 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 upvote it. + +If the icon has not already been requested, [create an issue](https://github.com/lucaburgio/iconoir/issues/new/choose) and add as much information as possible. +Follow the rules you see when opening a new bug report. + +## Bug Reports + +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. +Follow the rules you see when opening a new bug report.