Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

59 lines (36 loc) · 1.01 KB

How To Contribute

Installation

  • git clone <repository-url>
  • cd event-perk-grid
  • yarn install

Linting

  • yarn run lint
  • yarn run lint:fix

Testing

See test-setup.ts for information about useful test setup hooks.

Test Server

  • yarn start - Runs the test suite in "watch mode" using a webpack dev server

Testem

  • yarn test – Runs the test suite

Publishing

See the Release guide for details.

Running docs server in dev

Tab 1: Run the build in watch mode so that docs examples are guaranteed to be running the latest versions of the library. (Note: This doesn't apply to the script tag example)

yarn build --watch

Tab 2: Run the docs command in watch mode so that the docs app will have the latest typedoc information.

yarn docs --watch

Tab 3: Start the Ember server.

cd docs && yarn start

Visit http://localhost:4200/

Deploying docs

NOTE: This is done automatically during releases.

yarn docs:deploy