Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.03 KB
Raw

Opening an issue

Stack Overflow is the best place for general questions on how to use the library. Use the ember-cli-mirage tag.

It's best to ask a question with an attached Twiddle that demonstrates your bug/question. Use the Mirage Boilerplate Twiddle to reproduce your issue.

Contributing to Ember CLI Mirage

Docs development

The documentation site is built using Ember CLI AddonDocs, which means it is the Ember app located in the tests/dummy folder of this addon.

If you're just making a change to a single page in the docs, look for the "Edit this page" link at the bottom of that page. Click on that and propose your edits.

To make more substantial changes, you'll want to be able to develop the docs site locally. To run an AddonDocs site,

git clone git@github.com:miragejs/ember-cli-mirage.git
cd ember-cli-mirage/packages/ember-cli-mirage
yarn install
ember s

You should be able to visit localhost:4200 and see the docs site running locally. Now checkout a new branch, make your changes, and submit a PR!

Mirage development

To help out with Mirage development, first pull down the project locally and verify that all tests on master are passing.

git clone git@github.com:[your-name]/ember-cli-mirage.git
cd ember-cli-mirage/packages/ember-cli-mirage
yarn install
ember test

If all tests pass, you should be all set. Checkout a new branch to start developing, then submit a PR when you're ready!

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