|
1 | 1 | # How To Contribute |
2 | 2 |
|
| 3 | +It is always welcome to contribute to FastBoot project! Don't hesitate to open issues, submit PRs, or [chat with community](https://emberjs.com/community) for questions or help. |
3 | 4 |
|
4 | | -### Code organization |
| 5 | +## Code of Conduct |
| 6 | +[Ember Community Guidelines](https://emberjs.com/guidelines/) |
5 | 7 |
|
6 | | -The actual ember addon is in `./packages/ember-cli-fastboot`. We will be adding other `test-packages` to let us test with many different app scenarios with differing dependencies. |
| 8 | +## Code organization |
7 | 9 |
|
| 10 | +This project is organized in a monorepo, you can find the packages published to npm under `packages/` folder: |
| 11 | +- `fastboot` |
| 12 | +- `ember-cli-fastboot` |
| 13 | +- `fastboot-app-server` |
| 14 | +- `fastboot-express-middleware` |
8 | 15 |
|
9 | | -### Installation |
| 16 | +The `test-packages` folder contains sample apps and integration test suite used for testing the published packages. |
10 | 17 |
|
11 | | -* `git clone <repository-url>` |
12 | | -* `cd packages/ember-cli-fastboot` |
| 18 | +## Installation |
| 19 | + |
| 20 | +* `git clone https://github.com/ember-fastboot/ember-cli-fastboot/` |
| 21 | +* `cd ember-cli-fastboot` |
13 | 22 | * `yarn install` |
14 | 23 |
|
15 | 24 | ## Running tests |
16 | | -* `cd packages/ember-cli-fastboot` |
17 | | -* `yarn test:mocha` – Runs the test suite on the current Ember version |
18 | | -* `yarn test:ember` – Runs the test suite on the current Ember version |
19 | | -* `yarn test:ember --server` – Runs the test suite in "watch mode" |
| 25 | + |
| 26 | +* `yarn workspace integration-tests test` - Run integration test suite |
| 27 | +* `yarn workspace basic-app test:mocha` - Run sample app's test suite |
| 28 | +* `yarn workspace ember-cli-fastboot test:ember` – Runs the `ember-cli-fastboot` test suite |
| 29 | + |
| 30 | +You can run each package's own test suite specified in its `package.json` via [`yarn workspace`](https://classic.yarnpkg.com/en/docs/cli/workspace#yarn-workspace-workspace_name-command-) |
| 31 | + |
| 32 | +## Where to write test |
| 33 | + |
| 34 | +The packages in this monorepo are tightly integrated, consider these when writing new tests: |
| 35 | + |
| 36 | +* Unit testing individual package: add to the package's own `test` folder |
| 37 | +* Integration test that involve multiple packages: add to `test-packages/integration-tests` |
| 38 | +* Testing FastBoot rendered sample app as `ember-cli-fastboot` consumer: add to `test-packages/<the-sample-app>/test` |
0 commit comments