# Contributing to Font Awesome Pro ## Reporting Issues & Submitting Ideas/Requests Found a problem with Font Awesome Pro? Want to see a specific icon revised/added? Feel free to submit an issue on the GitHub project. But please keep the following in mind: 1. Please be nice. Font Awesome is a happy place. 2. Please [search](https://github.com/FortAwesome/Font-Awesome-Pro/search?type=Issues) to see if your issue was already reported. If it was, join in on the conversation or upvote that issue. 3. Before opening any issue, please read the generic [issue guidelines](https://github.com/necolas/issue-guidelines), by Nicolas Gallagher. 4. After doing everything above, feel free to [submit an issue](https://github.com/FortAwesome/Font-Awesome-Pro/issues/new). ### Icon Requests + Suggestions New icons mostly start as requests by the [Font Awesome Pro community on GitHub](../../issues). Want to request a new icon or category? Here are some things to keep in mind: 1. Please be nice. Font Awesome is a happy place. 3. Please [search](../../search?type=Issues) to see if your icon or category request already exists. If a request is found, please add a 👍 reaction to that one. #### Requesting Individual Icons 1. Please do not request comprehensive sets of icons related to a very specific field. 2. Please make requests for single icons, unless you are suggesting an icon category (see below). 3. Please and thank you if you include the following: - Title your [new issue](../../issues/new?title=Icon%20Request:%20icon-) `Icon request: icon-name` (e.g., `Icon request: icon-car`). - Include a few use cases for your requested icon. How do you plan on using it? - Attach a single color image or two that represent the idea you're going for. - Request concrete objects: it's harder to make an icon to represent happiness, it's easier to make a smiley face. ☺ #### Requesting Icon Categories 1. Include a few examples of icons or subjects to be covered in the category. How do you plan on using it? 2. Please and thank you if you include the following: - Title your [new issue](../../issues/new?title=Category%20Request:%20) `Category request: Category Name` (e.g., `Category request: Desserts`). Please note: at the moment **we are not accepting external icon contributions**. If you'd like us to design and add a specific icon, you can make a request via the steps above. Feel free to include inspiration (including your own sketches/designs) along with the request. ### Reporting Security Issues Please do not report security issues in public. Please email hello@fontawesome.com. ## Solve a bug in Font Awesome Pro? Want to contribute new features? Here are a few things to remember: 1. Please do not submit new icons. 2. Please submit all pull requests against `*-wip` branches. 3. If your PR only affect the docs, feel free to push against the `master` branch 3. All non-docs-related pull requests submitted against master will be summarily closed and this guide referenced. 4. After doing everything above, feel free to [submit a pull request](https://github.com/FortAwesome/Font-Awesome-Pro/issues/new). ## Key Branches - `master` is the latest, deployed version (use for pull request if they only affect the docs) - `*-wip` branches are the official work in progress branches for the next releases. All pull requests should be submitted against the appropriate branch ## Community ### Expectations We Have of You 1. You'll be nice to and courteous of everyone involved in the project, including your peers (again, Font Awesome is a happy place). 2. You will not distribute or use the icons, code, or assets in this project in a way that violates the [Font Awesome Pro Commercial license](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/LICENSE.md). This includes selling the plans to Old Slugworth. ### Expectations You Have of Us 1. We'll be nice, courteous, and prompt when responding in discussions and in sending updates. 2. We'll be pretty nerdy and funny when we can. Sorry, not sorry. :P 3. We'll provide progress and our process in a transparent way whenever possible so that you can follow along with and help us. ## Pull Requests - At the moment we are not accepting pull requests containing icons - Submit all pull requests against the appropriate `*-wip` branch for easier merging - If your PR only affect the docs, feel free to push against the `master` branch - Try not to pollute your pull request with unintended changes--keep them simple and small ## License By contributing your code, you agree to license your contribution under the terms of the the [Font Awesome Pro Commercial license](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/LICENSE.md) and the terms of the [MIT License](http://opensource.org/licenses/mit-license.html) for any contributions that are made open source as development progresses.