diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 0265b2065..8225671e0 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,15 +1,15 @@ ### 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] +Version: +Browser and version: - [ ] SVG with JS - [ ] Web Fonts with CSS @@ -18,9 +18,9 @@ Browser and version: [if applicable give us the browser specs] ### 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 diff --git a/.github/ISSUE_TEMPLATE/icon-request.md b/.github/ISSUE_TEMPLATE/icon-request.md index 5dcd4ae6e..682b1f3d2 100644 --- a/.github/ISSUE_TEMPLATE/icon-request.md +++ b/.github/ISSUE_TEMPLATE/icon-request.md @@ -1,15 +1,15 @@ -### Example image - -[insert the example image here] - ### What can it be used for? -[describe how this could be used / the use case for this icon] + + +### Example image (optional) + + ### 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/issues) and to the best of my knowledge this is not a duplicate -- [ ] I have included at least one example image +- [ ] 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. ☺) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..871e61ae1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,6 @@ + + +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. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..852f155f0 --- /dev/null +++ b/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 . 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/ diff --git a/README.md b/README.md index 9ac6b6741..541fa1004 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Font Awesome 5 Free +

Font Awesome 5 Free

-> The iconic SVG, font, and CSS framework +> Version 5 – the iconic SVG, font, and CSS framework The internet's most popular icon toolkit has been redesigned and built from scratch. On top of this, features like icon font ligatures, an SVG framework, @@ -13,7 +13,7 @@ successful Kickstarter and plan. You can also **[order Font Awesome Pro](https://fontawesome.com/pro)** which includes tons more icons directly from [fontawesome.com](https://fontawesome.com). -## Get started! +## Get started with 5! Learn how to [get started](https://fontawesome.com/get-started) with Font Awesome or dive deeper into [other topics](https://fontawesome.com/how-to-use). @@ -29,6 +29,20 @@ Learn how to [get started](https://fontawesome.com/get-started) with Font Awesom * [Performance and Security](https://fontawesome.com/how-to-use/performance-and-security) * [Accessibility](https://fontawesome.com/how-to-use/accessibility) +### Where did Font Awesome 4 (or 3) go? + +Now that Font Awesome 5 has been released we are marking version 4 as +end-of-life. We don't plan on releasing any further versions of the 4.x or 3.x. + +Documentation is still available but it's moved to +[https://fontawesome.com/v4.7.0](https://fontawesome.com/v4.7.0) and +[https://fontawesome.com/v3.2.1](https://fontawesome.com/v3.2.1). + +The Git repository for +[v4.7.0](https://github.com/FortAwesome/Font-Awesome/releases/tag/v4.7.0) and +[v3.2.1](https://github.com/FortAwesome/Font-Awesome/releases/tag/v3.2.1) can +be found in our GitHub releases. + ## Change log We'll keep track of each release in the [CHANGELOG.md](./CHANGELOG.md) @@ -41,6 +55,11 @@ From time-to-time we'll have special upgrading instructions from one version to Check out the [UPGRADING.md](./UPGRADING.md) guide when you upgrade your dependencies. +## Code of conduct + +We will behave ourselves if you behave yourselves. For more details see our +[CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md). + ## Contributing Please read through our [contributing guidelines](./CONTRIBUTING.md). Included @@ -88,3 +107,12 @@ files normally. We've kept attribution comments terse, so we ask that you do not actively work to remove them from files, especially code. They're a great way for folks to learn about Font Awesome. + +## Team + +* [Dave Gandy](https://github.com/davegandy) +* [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)