diff --git a/CHANGELOG.md b/CHANGELOG.md index cf6837935..570460bb5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). -## [Unreleased] +## Unreleased ### Added diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 13e81b099..fc88363fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,18 @@ # Contributing to Font Awesome Pro -## Reporting Issues -Found a problem with Font Awesome Pro? Feel free to submit an issue on the GitHub project. But please keep the following in mind: +## 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: 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). +### Icon Requests + Submissions +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. + +### 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: @@ -33,6 +37,7 @@ Please do not report security issues in public. Please email hello@fontawesome.c 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. ## Pull Requests - At the moment we are not accepting pull requests containing icons @@ -41,8 +46,5 @@ Please do not report security issues in public. Please email hello@fontawesome.c - Try not to pollute your pull request with unintended changes--keep them simple and small -## Coding standards - - ## 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. diff --git a/README.md b/README.md index 2a99785f1..bea777bbc 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,28 @@ The internet's most popular icon is being redesigned and built from scratch. on Not familiar with Font Awesome 5? [Learn more](https://www.kickstarter.com/projects/232193852/font-awesome-5) about our successful Kickstarter and plan. You can also **[pre-order your copy of Font Awesome Pro](http://five.fontawesome.io/)** and save off of the release price. - ## Project Progress -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). +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 + +### Icon Design Workflow + +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: + +* Icons will be kept within the [`icons`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons) directory in the repo. +* Font Awesome Free icons will be organized in the [`icons/free`](ttps://github.com/FortAwesome/Font-Awesome-Pro/blob/master/icons) directory +* 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). diff --git a/icons/free/camera.svg b/icons/free/camera.svg new file mode 100755 index 000000000..218956439 --- /dev/null +++ b/icons/free/camera.svg @@ -0,0 +1 @@ + diff --git a/icons/free/close-circle.svg b/icons/free/close-circle.svg new file mode 100755 index 000000000..fb5275e56 --- /dev/null +++ b/icons/free/close-circle.svg @@ -0,0 +1 @@ + diff --git a/icons/free/commenting.svg b/icons/free/commenting.svg new file mode 100755 index 000000000..f046bcbae --- /dev/null +++ b/icons/free/commenting.svg @@ -0,0 +1 @@ + diff --git a/icons/free/envelope.svg b/icons/free/envelope.svg new file mode 100755 index 000000000..35d97e683 --- /dev/null +++ b/icons/free/envelope.svg @@ -0,0 +1 @@ + diff --git a/icons/free/file.svg b/icons/free/file.svg new file mode 100755 index 000000000..82ee86b4a --- /dev/null +++ b/icons/free/file.svg @@ -0,0 +1 @@ + diff --git a/icons/free/home.svg b/icons/free/home.svg new file mode 100755 index 000000000..81228c875 --- /dev/null +++ b/icons/free/home.svg @@ -0,0 +1 @@ + diff --git a/icons/free/print.svg b/icons/free/print.svg new file mode 100755 index 000000000..e6fd7b881 --- /dev/null +++ b/icons/free/print.svg @@ -0,0 +1 @@ + diff --git a/icons/free/trash.svg b/icons/free/trash.svg new file mode 100755 index 000000000..8174580a2 --- /dev/null +++ b/icons/free/trash.svg @@ -0,0 +1 @@ + diff --git a/icons/pro/battery-75.svg b/icons/pro/battery-75.svg new file mode 100755 index 000000000..49f9ed461 --- /dev/null +++ b/icons/pro/battery-75.svg @@ -0,0 +1 @@ + diff --git a/icons/pro/camera-o.svg b/icons/pro/camera-o.svg new file mode 100755 index 000000000..749c679b2 --- /dev/null +++ b/icons/pro/camera-o.svg @@ -0,0 +1 @@ + diff --git a/icons/pro/check-square-o.svg b/icons/pro/check-square-o.svg new file mode 100755 index 000000000..243d26f1f --- /dev/null +++ b/icons/pro/check-square-o.svg @@ -0,0 +1 @@ + diff --git a/icons/pro/envelope-o.svg b/icons/pro/envelope-o.svg new file mode 100755 index 000000000..8ff5b8913 --- /dev/null +++ b/icons/pro/envelope-o.svg @@ -0,0 +1 @@ + diff --git a/icons/pro/jack-o-lantern.svg b/icons/pro/jack-o-lantern.svg new file mode 100755 index 000000000..a3641060f --- /dev/null +++ b/icons/pro/jack-o-lantern.svg @@ -0,0 +1 @@ + diff --git a/icons/pro/poo.svg b/icons/pro/poo.svg new file mode 100755 index 000000000..bfc8b3213 --- /dev/null +++ b/icons/pro/poo.svg @@ -0,0 +1 @@ + diff --git a/icons/pro/print-o.svg b/icons/pro/print-o.svg new file mode 100755 index 000000000..5159c5ea3 --- /dev/null +++ b/icons/pro/print-o.svg @@ -0,0 +1 @@ + diff --git a/icons/pro/soccer-ball.svg b/icons/pro/soccer-ball.svg new file mode 100755 index 000000000..11d8fa089 --- /dev/null +++ b/icons/pro/soccer-ball.svg @@ -0,0 +1 @@ + diff --git a/icons/pro/trash-o.svg b/icons/pro/trash-o.svg new file mode 100755 index 000000000..8c298595a --- /dev/null +++ b/icons/pro/trash-o.svg @@ -0,0 +1 @@ + diff --git a/icons/pro/yin-yang.svg b/icons/pro/yin-yang.svg new file mode 100755 index 000000000..c9b63a681 --- /dev/null +++ b/icons/pro/yin-yang.svg @@ -0,0 +1 @@ +