diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d68234d8..a78162ed3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,9 +9,10 @@ Looking to contribute something to Font Awesome? **Here's how you can help.** 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 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: +2. Please do not request comprehensive sets of icons related to a very specific field. +3. Please [search](../../search?type=Issues) to see if your icon request already exists. If a request is found, please +1 that one. +4. Please make requests for single icons, unless you are requesting a couple of strictly related icons (e.g., thumbs-up/thumbs-down). +5. 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. @@ -51,6 +52,7 @@ As of v3.2.0, Font Awesome's CSS, LESS, SCSS, and documentation are all powered - 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 - Any changes to the docs must be made to the Liquid templates in the `src` directory - Any changes to the styles must be made to the .less and .scss files in the `src` directory - If modifying the .less and .scss files, always recompile and commit the compiled files