thanthos/Font-Awesome-Pro
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Syncing & Updating README (#1016)

Browse Source 
syncing README with Font-Awesome repo.
This commit is contained in:
Brian Talbot
2018-02-07 11:04:33 -05:00
committed by GitHub
parent f9caec3cf6
commit faac9475f2
7 changed files with 210 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
CONTRIBUTING.md
View File

@@ -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
Found a problem with Font Awesome Pro? Feel free to submit an issue on the GitHub project. But please keep the following in mind:
## Quick start
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).
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 do not report security issues in public. Please email hello@fontawesome.com.
### Icon Requests + Suggestions
New icon design mostly starts as requests by the [Font Awesome Pro community on GitHub](../../issues).
* [Request a new icon](https://github.com/FortAwesome/Font-Awesome/issues/new?title=Icon%20request:%20icon-name&template=icon-request.md)
* [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
**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).
## Key branches
#### Requesting Icon Categories
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?
- `master` is the latest, deployed version
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
- 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
- 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.
- Pull requests that do not solve an existing issue are essentially un-prioritized–don't expect these to be addressed quickly
- 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 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.