Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.24 KB
Raw

How To Contribute

This repo is divided into multiple packages using workspaces:

  • addon is the actual ember-keyboard addon
  • docs documentation app for ember-keyboard Ember.js addon
  • test-app contains ember-keyboard test suite

Installation

  • git clone https://github.com/adopted-ember-addons/ember-keyboard.git
  • cd ember-keyboard
  • pnpm install

Linting

Inside any of the packages you can run:

  • pnpm run lint
  • pnpm run lint:fix

Running tests

  • cd addon && pnpm start – Builds the addon in "watch mode" so changes picked up by test app.
  • cd test-app && ember test – Runs the test suite on the current Ember version
  • cd test-app && ember test --server – Runs the test suite in "watch mode"
  • cd test-app && ember try:each – Runs the test suite against multiple Ember versions

During development, if you'd like test app to pick up changes in the addon, make sure to run both cd addon && pnpm start and cd test-app && ember test --server in different terminals.

Running the test application

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