updating CONTRIBUTING.md

This commit is contained in:
Brian Talbot
2017-02-06 11:41:37 -05:00
committed by GitHub
parent 0a12613c61
commit a7e4dd1e3b

View File

@@ -2,7 +2,7 @@
## Reporting Issues & Submitting Ideas/Requests ## 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: Found a problem with Font Awesome Pro? 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. 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. 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.
@@ -10,26 +10,17 @@ Found a problem with Font Awesome Pro? Want to see a specific icon revised/added
4. After doing everything above, feel free to [submit an issue](https://github.com/FortAwesome/Font-Awesome-Pro/issues/new). 4. After doing everything above, feel free to [submit an issue](https://github.com/FortAwesome/Font-Awesome-Pro/issues/new).
### Icon Requests + Suggestions ### 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: New icon design mostly starts as requests by the [Font Awesome Pro community on GitHub](../../issues).
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 #### Requesting Individual Icons
1. Please do not request comprehensive sets of icons related to a very specific field. **We are currently not accepting individual icon requests**. This may change in the future, but for now we're focused on Icon Categories. However, if you have a specific brand icon you would like added, you may request it in the [official brand icon request thread](https://github.com/FortAwesome/Font-Awesome-Pro/issues/232).
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 #### 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? 1. Please [search](https://github.com/FortAwesome/Font-Awesome-Pro/labels/icon%20category%20request) to see if your icon category request already exists. If a request is found, please add a 👍 reaction to that one.
2. Please and thank you if you include the following: 2. If you're adding a new request, please and thank you if you title your [new issue](../../issues/new?title=Category%20Request:%20) `Category Request: Category Name` (e.g., `Category Request: Desserts`).
- Title your [new issue](../../issues/new?title=Category%20Request:%20) `Category request: Category Name` (e.g., `Category request: Desserts`). 3. Include a few examples of icons or subjects to be covered in the category. How do you plan on using it?
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. Please note: at the moment **we are not accepting external icon contributions**.
### Reporting Security Issues ### Reporting Security Issues
Please do not report security issues in public. Please email hello@fontawesome.com. Please do not report security issues in public. Please email hello@fontawesome.com.