diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..52fd7be --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,13 @@ +### Describe the problem + + + +### What did you expect? + + + +### Reproducible test case + + + + diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..ce71570 --- /dev/null +++ b/.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 + + + +### Is this in relation to an existing part of vue-fontawesome or something new? + + + +### What is 1 thing that we can do when building this feature that will guarantee that it is awesome? + + + +### Why would other vue-fontawesome users care about this? + + + +### On a scale of 1 (sometime in the future) to 10 (absolutely right now), how soon would you recommend we make this feature? + + + +### 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/vue-fontawesome/issues) and to the best of my knowledge this is not a duplicate diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..852f155 --- /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/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c197907 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +This is the repository for the _official_ Font Awesome Angular component, _initialized_ by the team behind Font Awesome, +but intended to evolve over time with _community_ contributions. + +# Ways to Contribute + +## Ask a Question + +Trying to figure out how to make it work? Or how to use it in your scenario? + +1. Review the [README](README.md) +1. Get familiar with the documentation for the [SVG with JavaScript](https://fontawesome.com/how-to-use/svg-with-js) implementation, +the framework upon which this component is built. Sometimes the answers you need may be there. +1. Post any remaining questions on [StackOverflow](https://stackoverflow.com/questions/tagged/vue-fontawesome) with the tag `vue-fontawesome`. + +## Report a Bug + +1. Create a test case that reproduces the unexpected behavior using [codesandbox.io](https://codesandbox.io) +1. [Open a new issue with this template](https://github.com/FortAwesome/vue-fontawesome/issues/new?template=bug-report.md), +and be sure to include a link to the reproduction you made with StackBlitz. + +## Submit a Pull Request + +Add tests if you add code. + +## Everything Else + +* [Request a feature](https://github.com/FortAwesome/vue-fontawesome/issues/new??title=Feature%20request:feature-name&template=feature-request.md) +* [Request a new icon](https://github.com/FortAwesome/Font-Awesome/issues/new?title=Icon%20request:%20icon-name&template=icon-request.md) + +# Project Goals + +1. Achieve and maintain feature parity with Font Awesome's [SVG with JavaScript](https://fontawesome.com/how-to-use/svg-with-js) method. + +1. Keep with best practices in the Angular development community. + +1. Stay current with major developments in Angular and Angular-CLI + +1. Maintain a reasonable level of consistency between this component and the other Font Awesome official JavaScript +framework components ([Vue](https://github.com/FortAwesome/angular-fontawesome), [React](https://github.com/FortAwesome/react-fontawesome), [Ember](https://github.com/FortAwesome/ember-fontawesome)) + +1. Sharing responsibility: The Font Awesome team will continue to be involved in ongoing development, hoping to _propel_ +the project's momentum as we make _our_ contributions, while minimizing any bottle-necking that may happen as we balance +our own priorities across various projects. Ideally, members of the community will enjoy lending a hand to help keep +the project moving forward by responding to issues, answering questions on StackOverflow, reviewing and merging pull +requests, and publishing npm updates. + +# Code of Conduct + +We'll contribute according to the [Code of Conduct](CODE_OF_CONDUCT.md). + +# Wanted: Core Contributors + +We're seeking core contributors to help drive this project. Core contributors: +1. Share these goals +1. Demonstrate competence through contributions +1. Contribute with conduct fitting with our code of conduct +1. Want to make this project awesome diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..5004d2d --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,22 @@ +# Developing vue-fontawesome + +## Tasks + +The following commands are available through `npm run` or `yarn`: + +Command | Purpose +--- | --- +build | Build a development version of the library using Rollup +dist | Build a production version of the library using Rollup +test | Execute unit tests + +## Release this project + + +1. Update `package.json` and change `version` +1. Update `README.md` and add any contributors +1. Update the `CHANGELOG.md` +1. `npm run dist` +1. `git commit -a -m 'Release VERSION'` +1. `git push` +1. Create a [new release](https://github.com/FortAwesome/vue-fontawesome/releases/new) with CHANGELOG details diff --git a/README.md b/README.md index 5bf7308..787c227 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,9 @@ + [How about a separate property for the prefix?](#how-about-a-separate-property-for-the-prefix) + [Bindings become boilerplate and verbose](#bindings-become-boilerplate-and-verbose) + [Properties can disagree with each other](#properties-can-disagree-with-each-other) +- [How to Help](#how-to-help) +- [Contributors](#contributors) +- [Releasing this project](#releasing-this-project) @@ -555,3 +558,39 @@ export default { } ``` + +## How to Help + +Review the following docs before diving in: + +* [CONTRIBUTING.md](CONTRIBUTING.md) +* [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) + +And then: + +1. Check the existing issue and see if you can help! + +## Contributors + +The following contributors have either hepled to start this project, have contributed +code, are actively maintaining it (including documentation), or in other ways +being awesome contributors to this project. **We'd like to take a moment to recognize them.** + +| | Name | GitHub | +| :--------------------------------------------------------: | -------------- | -------------------------------------------------- | +| | SirLamer | [@SirLamer](https://github.com/SirLamer) | + +If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved. + +The Font Awesome team: + +| | Name | GitHub | +| :--------------------------------------------------------: | -------------- | -------------------------------------------------- | +| | Travis Chase | [@supercodepoet](https://github.com/supercodepoet) | +| | Rob Madole | [@robmadole](https://github.com/robmadole) | +| | Mike Wilkerson | [@mlwilkerson](https://github.com/mlwilkerson) | +| | Brian Talbot | [@talbs](https://github.com/talbs) | + +## Releasing this project + +See [DEVELOPMENT.md](DEVELOPMENT.md#release)