Skip to content

Latest commit

 

History

History
84 lines (53 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

84 lines (53 loc) · 3.44 KB
Raw

This is the repository for the official Font Awesome Ember 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
  2. Get familiar with the documentation for the SVG with JavaScript implementation, the framework upon which this component is built. Sometimes the answers you need may be there.
  3. Post any remaining questions on StackOverflow with the tag ember-fontawesome.

Report a Bug

  1. Create a test case that reproduces the unexpected behavior
  2. Open a new issue with this template, 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

Project Goals

  1. Achieve and maintain feature parity with Font Awesome's SVG with JavaScript method.

  2. Keep with best practices in the Ember development community.

  3. Stay current with major developments in Ember and Ember-CLI

  4. Maintain a reasonable level of consistency between this component and the other Font Awesome official JavaScript framework components (Vue, React, Angular)

  5. 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.

Wanted: Core Contributors

We're seeking core contributors to help drive this project. Core contributors:

  1. Share these goals
  2. Demonstrate competence through contributions
  3. Contribute with conduct fitting with our code of conduct
  4. Want to make this project awesome

How To Contribute

Installation

  • git clone <repository-url>
  • cd my-addon
  • yarn

Linting

  • yarn lint
  • yarn lint:fix

Running tests

  • ember test – Runs the test suite on the current Ember version
  • ember test --server – Runs the test suite in "watch mode"
  • ember try:each – Runs the test suite against multiple Ember versions

Running the dummy application

For more information on using ember-cli, visit https://ember-cli.com/.