Skip to content

Commit

Permalink
[DDW-617] update readme and pr template
Browse files Browse the repository at this point in the history
  • Loading branch information
DominikGuzei committed Apr 8, 2019
1 parent 8e3c798 commit 5ea7ee3
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 15 deletions.
16 changes: 8 additions & 8 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,17 @@ This PR CHANGES.
- [ ] PR is updated to the most recent version of the target branch (and there are no conflicts)
- [ ] PR has a good description that summarizes all changes and shows some screenshots or animated GIFs of important UI changes
- [ ] CHANGELOG entry has been added to the top of the appropriate section (*Features*, *Fixes*, *Chores*) and is linked to the correct PR on GitHub
- [ ] Automated tests: All acceptance and unit tests are passing (`yarn run test` and `yarn run test:unit`)
- [ ] Manual tests (minimum tests should cover newly added feature/fix): App works correctly in *development* build (`yarn run dev`)
- [ ] Manual tests (minimum tests should cover newly added feature/fix): App works correctly in *production* build (`yarn run package` / CI builds)
- [ ] There are no *flow* errors or warnings (`yarn run flow:test`)
- [ ] There are no *lint* errors or warnings (`yarn run lint`)
- [ ] There are no *prettier* errors or warnings (`yarn run prettier:check`)
- [ ] There are no missing translations (running `yarn run manage:translations` produces no changes)
- [ ] Automated tests: All acceptance and unit tests are passing (`yarn test`)
- [ ] Manual tests (minimum tests should cover newly added feature/fix): App works correctly in *development* build (`yarn dev`)
- [ ] Manual tests (minimum tests should cover newly added feature/fix): App works correctly in *production* build (`yarn package` / CI builds)
- [ ] There are no *flow* errors or warnings (`yarn flow:test`)
- [ ] There are no *lint* errors or warnings (`yarn lint`)
- [ ] There are no *prettier* errors or warnings (`yarn prettier:check`)
- [ ] There are no missing translations (running `yarn manage:translations` produces no changes)
- [ ] Text changes are proofread and approved (Jane Wild / Amy Reeve)
- [ ] Japanese text changes are proofread and approved (Junko Oda)
- [ ] UI changes look good in all themes (Alexander Rukin)
- [ ] Storybook works and no stories are broken (`yarn run storybook`)
- [ ] Storybook works and no stories are broken (`yarn storybook`)
- [ ] In case of dependency changes `yarn.lock` file is updated

### Code Quality
Expand Down
30 changes: 23 additions & 7 deletions features/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,46 @@
<sub>Document maintainer: Nikola Glumac<br/>Document status: Active</sub>
</blockquote>

# Running Daedalus acceptance tests

# Install Daedalus

1. Make sure you have node and yarn installed on your machine
2. Clone Daedalus repository to your machine (`git clone [email protected]:input-output-hk/daedalus.git`)
3. Install dependencies from within Daedalus directory:

```bash
$ cd daedalus/
$ yarn install
```

4. Build and run the backend (Cardano SL) following the instructions from [Daedalus](https://github.com/input-output-hk/daedalus/blob/master/README.md#development---with-cardano-wallet) README file.
5. Run Daedalus frontend tests:
# Run unit tests

Make sure Daedalus is properly installed (see above).

```bash
$ yarn test:unit
```

# Run UI tests

1. Make sure Daedalus is properly installed (see above).
2. Build and run the backend (Cardano SL) following the instructions from [Daedalus](https://github.com/input-output-hk/daedalus/blob/master/README.md#development---with-cardano-wallet) README file.
3. Run Daedalus frontend tests:

```bash
$ cd daedalus/
$ nix-shell --arg autoStartBackend true --arg systemStart XXX # XXX = cardano system startup time
$ yarn nix:dev XXX # XXX = cardano system startup time
$ yarn build
$ yarn test:ui
```

# Run all tests

```bash
$ yarn test
```

Once tests are complete you will get a summary of passed/failed tests in the Terminal window.

## Keeping Daedalus Alive After Tests
## Keeping Daedalus Alive After UI Tests

While working on the tests it's often useful to keep Daedalus alive after the tests have run
(e.g: to inspect the app state). You can pass a special environment var to tell the test script
Expand Down

0 comments on commit 5ea7ee3

Please sign in to comment.