Updated contributing.md

Updated “request new icons” section and fixed smiley icon
This commit is contained in:
Geremia Taglialatela 2014-05-27 11:04:18 +02:00
parent 1a0574feca
commit 791e0fe22b
3 changed files with 23 additions and 6 deletions

View file

@ -4,6 +4,21 @@ Looking to contribute something to Font Awesome? **Here's how you can help.**
## Requesting new icons
New icons mostly start as requests by the [Font Awesome community on GitHub](/issues). Want to request a new icon? Here are some things to keep in mind:
1. Please be nice. Font Awesome is a happy place.
2. Please [search](/search?type=Issues) to see if your icon request already exists. If a request is 1. found, please +1 that one.
3. Please make requests for single icons, unless you are requesting a couple of strictly related icons (e.g., thumbs-up/thumbs-down).
4. Please and thank you if you include the following:
- Title your [new issue](/issues/new?title=Icon%20Request:%20fa-) `Icon request: fa-name` (e.g., `Icon request: fa-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.
- Please request concrete objects: it's harder to make an icon to represent happiness, it's easier to make a smiley face. ☺
## Reporting issues
We only accept issues that are icon requests, bug reports, or feature requests. Bugs must be isolated and reproducible problems that we can fix within the Font Awesome core. Please read the following guidelines to ensure you are the paragon of bug reporting.

View file

@ -7,21 +7,23 @@
</p>
<ol>
<li>Please be nice. Font Awesome is a happy place.</li>
<li>Please <a href="{{ site.fontawesome.github.url }}/search?type=Issues">search</a> to see if your icon request already exists.</li>
<li>Please <a href="{{ site.fontawesome.github.url }}/search?type=Issues">search</a> to see if your icon request already exists. If a request is found, please +1 that one.</li>
<li>
Please make requests for single icons, unless you are requesting a couple of strictly related icons (e.g., thumbs-up/thumbs-down).
</li>
<li>
Please and thank you if you include the following:
<ul>
<li>
Title your <a href="{{ site.fontawesome.github.url }}/issues/new?title=Icon%20Request:%20icon-name">new issue</a>
<code>Icon request: icon-name</code>.
Title your <a href="{{ site.fontawesome.github.url }}/issues/new?title=Icon%20Request:%20fa-">new issue</a>
<code>Icon request: fa-name</code> (e.g., <code>Icon request: fa-car</code>).
</li>
<li>Include a few use cases for your requested icon. How do you plan on using it?</li>
<li>Attach a single color image or two that represent the idea you're going for.</li>
</ul>
</li>
<li>
Concrete objects make good icons, since abstract concepts are, well, abstract. It's harder to make an icon
to represent happiness. It's easier to make a smiley face. <i class="fa fa-smile"></i>
Please request concrete objects: it's harder to make an icon to represent happiness, it's easier to make a smiley face. <i class="fa fa-smile-o"></i>
</li>
</ol>
</section>

View file

@ -24,8 +24,8 @@ relative_path: ../
{% include stripe-ad.html %}
{% include community/getting-support.html %}
{% include community/reporting-bugs.html %}
{% include community/requesting-new-icons.html %}
{% include community/reporting-bugs.html %}
{% include community/submitting-pull-requests.html %}
{% include community/project-milestones.html %}