Syncing & Updating README (#1016)

syncing README with Font-Awesome repo.

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,34 @@
+### Describe the problem
+
+<!--- What happened? What are you seeing? How did you arrive here? -->
+
+### What did you expect?
+
+<!--- How would you like this to work instead? -->
+
+### What version and implementation are you using?
+
+Version: <!--- Give us the version number here -->
+Browser and version: <!--- If applicable give us the browser specs -->
+
+- [ ] SVG with JS
+- [ ] Web Fonts with CSS
+- [ ] SVG Sprites
+- [ ] On the Desktop
+
+- [ ] Font Awesome Solid
+- [ ] Font Awesome Regular
+- [ ] Font Awesome Light
+- [ ] Font Awesome Brands
+
+### Reproducible test case
+
+<!--- Insert a URL to your test case - use codepen.io, jsfiddle.net, jsbin.com, codesandbox.io, or whatever -->
+
+<!--- Describe any details about the test case that we need to know like "whatever you do, don't click the red button" -->
+
+### Bug report checklist
+
+- [ ] I have filled out as much of the above information as I can
+- [ ] I have included a test case because my odds go _way_ up that the team can fix this when I do
+- [ ] I have [searched for existing issues](https://github.com/FortAwesome/Font-Awesome-Pro/issues) and to the best of my knowledge this is not a duplicate

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,25 @@
+### Describe the problem you'd like to see solved or task you'd like to see made easier
+
+<!--- What steps or tasks are you trying to complete when the problem -->
+
+### Is this in relation to an existing part of Font Awesome or something new?
+
+<!--- If so, what part of Font Awesome? -->
+
+### What is 1 thing that we can do when building this feature that will guarantee that it is awesome?
+
+<!--- e.g. make finding icons while I'm designing super fast  -->
+
+### Why would other Font Awesome users care about this?
+
+<!--- e.g. because everyone wants icons that fly  -->
+
+### On a scale of 1 (sometime in the future) to 10 (absolutely right now), how soon would you recommend we make this feature?
+
+<!--- e.g. 5 - "while we're young" -->
+
+### Feature request checklist
+
+- [ ] This is a single feature (i.e. not a re-write of all of Font Awesome)
+- [ ] The title starts with "Feature request: " and is followed by a clear feature name (Ex: `Feature request: moar cowbell`)
+- [ ] I have [searched for existing issues](https://github.com/FortAwesome/Font-Awesome-Pro/issues) and to the best of my knowledge this is not a duplicate

.github/ISSUE_TEMPLATE/icon-request.md

@@ -0,0 +1,15 @@
+### What can it be used for?
+
+<!--- describe how this could be used / the use case for this icon -->
+
+### Example image (optional)
+
+<!--- insert the example image here if necessary -->
+
+### Icon request checklist
+
+- [ ] This is a single icon or matched pair (Ex: `lock` / `unlock`)
+- [ ] The title starts with "Icon request: " and is followed by the requested icon name (Ex: `Icon request: magical-unicorn`)
+- [ ] I have [searched for existing issues](https://github.com/FortAwesome/Font-Awesome-Pro/issues) and to the best of my knowledge this is not a duplicate
+- [ ] I have included at least one example image if it could be helpful (optional)
+- [ ] The request is for a concrete object (it's harder to make an icon to represent happiness, it's easier to make a smiley face. ☺)

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+<!--- WARNING Pull Requests made to this repository cannot be merged -->
+
+I understand that:
+
+- [ ] I'm submitting this PR for reference only. It shows an example of what I'd like to see changed but
+  I understand that it will not be merged and I will not be listed as a contributor on this project.

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at <hello@fontawesome.com>. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -1,66 +1,28 @@
 # Contributing to Font Awesome Pro
 
+Looking to contribute something to Font Awesome Pro? **Here's how you can help.**
 
-## Reporting Issues & Submitting Ideas/Requests
+## Quick start
-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.
+We only accept issues that are icon requests, bug reports, or feature requests.
-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.
+Bugs must be isolated and reproducible problems that we can fix within the Font
-3. Before opening any issue, please read the generic [issue guidelines](https://github.com/necolas/issue-guidelines), by Nicolas Gallagher.
+Awesome core. Please do not report security issues in public. Please email hello@fontawesome.com.
-4. After doing everything above, feel free to [submit an issue](https://github.com/FortAwesome/Font-Awesome-Pro/issues/new).
 
-### Icon Requests + Suggestions
+* [Request a new icon](https://github.com/FortAwesome/Font-Awesome/issues/new?title=Icon%20request:%20icon-name&template=icon-request.md)
-New icon design mostly starts as requests by the [Font Awesome Pro community on GitHub](../../issues).
+* [Submit a bug report](https://github.com/FortAwesome/Font-Awesome/issues/new?template=bug-report.md)
+* [Request a feature request](https://github.com/FortAwesome/Font-Awesome/issues/new?title=Feature%20request:%20&template=feature-request.md)
 
-#### Requesting Individual Icons
+## Key branches
-**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).
 
-#### Requesting Icon Categories
+- `master` is the latest, deployed version
-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. 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`).
-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**.
+## Pull requests
 
-### 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.
-
-### Ways of contacting us directly
-
-We want to keep the GitHub issues focused on the development of the project. If you have a topic that you'd like us to be aware of that doesn't relate directly to the work product of this project you can send us an email at hello@fontawesome.com.
-
-## 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
+- Pull requests that do not solve an existing issue are essentially un-prioritized–don't expect these to be addressed quickly
-- If your PR only affect the docs (on github or eventually on [fontawesome.com](https://fontawesome.com/)), feel free to push against the `master` branch
+- The files in this repository are generated elsewhere and we do not merge PR's directly into master
-- Try not to pollute your pull request with unintended changes--keep them simple and small
+- Try not to pollute your pull request with unintended changes–keep them simple and small
-- By submitting a pull request, you’re assigning all rights and privileges to the Font Awesome Team. We’ll make things in this repo open source wherever we can. If you have questions or need more clarification about this, feel free to contact us at hello@fontawesome.com.
+- Try to share which browsers your code has been tested in before submitting a pull request
-
 
 ## 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.

README.md

@@ -24,32 +24,46 @@ Learn how to [get started](https://fontawesome.com/get-started) with Font Awesom
 
 Login to your https://fontawesome.com account to download the latest version of Font Awesome Pro.
 
-## Project Progress
+## Change log
-Keep track of our progress through this project's [change log](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/CHANGELOG.md). Want to keep up with what's planned for Font Awesome Pro? Check out [our milestones](https://github.com/FortAwesome/Font-Awesome-Pro/milestones?direction=asc&sort=due_date&state=open).
 
-## How We'll Work
+We'll keep track of each release in the [CHANGELOG.md](./CHANGELOG.md)
 
-### Icon Design Workflow
+Looking for older versions of Font Awesome? Check the [releases](https://github.com/FortAwesome/Font-Awesome-Pro/releases)
 
-We'll be releasing design concepts for icons as we make progress. Please check the project's [milestones](https://github.com/FortAwesome/Font-Awesome-Pro/milestones?direction=asc&sort=due_date&state=open) for icon design status. Icons will be organized in the following ways:
+## Code of conduct
 
-* Icons will be kept within the [`icons`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons) directory in the repo.
+We will behave ourselves if you behave yourselves. For more details see our
-* Font Awesome Free icons will be organized in the [`icons/free`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons) directory
+[CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
-* Font Awesome Pro icons will be organized in the [`icons/pro`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons/free) directory
-* Icon category packs will be contained within the `_categories` folder of `free`/`pro` directories.
-* Each icon will have a production-ready version (`[icon-name].svg`) created for each of its styles and states.
-* We may eventually add preview boards of different icon groups (styles, categories, etc.) for easier browsing/consistency reviews.
-* We may share more work in progress files for specific icons as part of pull requests.
-
-We'll use the following tools to design and produce icons:
-
-* Adobe Illustrator
-* Inkscribe
-* SVGO for optimization
 
 ## Contributing
-Contributions, in code and constructive feedback, are very welcome. Please read through our [contributing guidelines](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/CONTRIBUTING.md).
+
-Included are directions for opening issues, coding standards, and community expectations.
+Please read through our [contributing guidelines](./CONTRIBUTING.md).  Included
+are directions for opening issues.
+
+## Versioning
+
+Font Awesome Pro will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered
+with the following format:
+
+`<major>.<minor>.<patch>`
+
+For more information on SemVer, please visit http://semver.org.
+
+**The major version "5" is part of an umbrella release.  It includes many different types of files and technologies. Therefore
+we deviate from normal SemVer in the following ways:**
+
+* Any release may update the design, look-and-feel, or branding of an existing
+  icon
+* We will never intentionally release a `patch` version update that breaks
+  backward compatibility
+* A `minor` release **may include backward-incompatible changes** but we will
+  write clear upgrading instructions in UPGRADING.md
+* A `minor` or `patch` release will never remove icons
+* Bug fixes will be addressed as `patch` releases unless they include backward
+  incompability then they will be `minor` releases
+
+## Copyright and License
+The icons, code, and assets included in project are licensed under the Font Awesome Pro commercial license - see [this project's license file](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/LICENSE.md) for details.
 
 ## Questions and Contact Us
 Font Awesome Pro received backing by thousands of people (thanks again!). With that said, addressing each and every question is a lot of work and the more the community and documentation can help each other, the more we can use that time to focus on getting Pro features out. If you do need to reach out to us, here's how to do it:
@@ -58,22 +72,11 @@ Font Awesome Pro received backing by thousands of people (thanks again!). With t
 * **Account/Billing-related inquiries** - email hello@fontawesome.com
 * **Questions about [our Kickstarter](https://www.kickstarter.com/projects/232193852/font-awesome-5) campaign** - If you are a backer (thanks, btw!), please reply to individual updates or send a message through Kickstarter.
 
-## Versioning
-Font Awesome Pro will be maintained under the [Semantic Versioning guidelines](http://semver.org) as much as possible. Releases will be numbered
-with the following format:
-
-`<major>.<minor>.<patch>`
-
-And constructed with the following guidelines:
-
-* Breaking backward compatibility bumps the major (and resets the minor and patch)
-* New additions, including new icons, without breaking backward compatibility bumps the minor (and resets the patch)
-* Bug fixes, changes to brand logos, and misc changes bumps the patch
-
-## Copyright and License
-The icons, code, and assets included in project are licensed under the Font Awesome Pro commercial license - see [this project's license file](https://github.com/FortAwesome/Font-Awesome-Pro/blob/master/LICENSE.md) for details.
-
 ## Team
-[<img src="https://img.fortawesome.com/349cfdf6/dave-pixelated-800.png" alt="" height="100">](https://github.com/davegandy) | [<img src="https://img.fortawesome.com/349cfdf6/travis-pixelated-800.png" alt="" height="100">](https://github.com/supercodepoet) | [<img src="https://img.fortawesome.com/349cfdf6/rob-pixelated-800.png" alt="" height="100">](https://github.com/robmadole) | [<img src="https://img.fortawesome.com/349cfdf6/brian-pixelated-800.png" alt="" height="100">](https://github.com/talbs)
+
----|---|---|---
+* [Dave Gandy](https://github.com/davegandy)
-[Dave Gandy](https://github.com/davegandy) | [Travis Chase](https://github.com/supercodepoet) | [Rob Madole](https://github.com/robmadole) | [Brian Talbot](https://github.com/talbs)
+* [Travis Chase](https://github.com/supercodepoet)
+* [Rob Madole](https://github.com/robmadole)
+* [Brian Talbot](https://github.com/talbs)
+* [Jory Raphael](https://github.com/sensibleworld)
+* [Mike Wilkerson](https://github.com/mlwilkerson)