Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (31 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

49 lines (31 loc) · 1.53 KB
Raw

How To Contribute

This repo is divided into multiple packages using pnpm workspaces:

  • addon is the actual ember-animated addon
  • test-app is its test suite
  • docs is the documentation/marketing site

Installation

  • git clone https://github.com/ember-animation/ember-animated.git
  • cd ember-animated
  • pnpm install

Linting

  • pnpm lint
  • pnpm lint:fix

Building the addon

  • cd addon
  • pnpm build

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

Running the documentation application

The docs are in a standalone app in the /docs subdirectory.

  • cd addon && pnpm run start – Builds the addon in "watch mode" so changes picked up by the docs app.
  • cd docs && ember serve
  • Visit the docs application at http://localhost:4200.

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