Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README: Move contributing instructions to
CONTRIBUTING.md
- Loading branch information
Showing
2 changed files
with
21 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters