Skip to content

Commit

Permalink
README: Move contributing instructions to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Turbo87 committed Mar 21, 2019
1 parent 5abf1fd commit ebcbf18
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 11 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,19 @@
# Contributing / Developing

## Run the test suite

1. Clone this repo.
2. Run `yarn compile` (or `yarn compile --watch`).
3. Run `yarn lint` and `yarn test`.

`yarn test` uses [Jest](https://jestjs.io/) to run multiple tests in parallel.
Unfortunately, for now you will still have to run `yarn compile` before running
the tests to compile the TypeScript code to JavaScript.


## Use a local version of embroider to compile your projects

1. Clone this repo.
2. Run `yarn compile` (or `yarn compile --watch`).
3. In each of the `./packages/*` directories, run `yarn link`.
4. In your app, `yarn link @embroider/core` and the other packages you need.
13 changes: 2 additions & 11 deletions README.md
Expand Up @@ -49,15 +49,6 @@ yarn add --dev @embroider/core @embroider/compat @embroider/webpack

3. Use `ember serve`, `ember test`, and `ember build` as usual.

# Contributing / Developing
# Contributing

1. Clone this repo.
2. Run `yarn compile` (or `yarn compile --watch`).
3. In each of the `./packages/*` directories, run `yarn link`.
4. In your app, `yarn link @embroider/core` and the other packages you need.

# Tests

`yarn test` uses [Jest](https://jestjs.io/) to run multiple tests in parallel.
Unfortunately, for now you will still have to run `yarn compile` before running
the tests to compile the TypeScript code to JavaScript.
see [`CONTRIBUTING.md`](CONTRIBUTING.md)

0 comments on commit ebcbf18

Please sign in to comment.