Skip to content

Commit 8599449

Browse files
committed
docs: readme explains how to run tests (conventional-changelog#3639)
1 parent b73c8b4 commit 8599449

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ echo "your commit message here" | commitlint # fails/passes
3636

3737
## Checklist:
3838

39-
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
39+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. See the README for information on testing. -->
4040
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
4141

4242
- [ ] My change requires a change to the documentation.

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
- [License](#license)
3232
- [Development](#development)
3333
- [Install and run](#install-and-run)
34+
- [Testing](#testing)
3435
- [Publishing a release](#publishing-a-release)
3536

3637
---
@@ -254,6 +255,17 @@ yarn start # run tests, again on change
254255

255256
For more information on how to contribute please take a look at our [contribution guide](./.github/CONTRIBUTING.md).
256257

258+
### Testing
259+
260+
From the project root directory, use the following commands to run the test suite
261+
262+
```sh
263+
yarn clean
264+
yarn install
265+
yarn build
266+
yarn test
267+
```
268+
257269
### Package dependency overview
258270

259271
![commitlint-dependencies](https://user-images.githubusercontent.com/4248851/58385093-34b79780-7feb-11e9-8f27-bffc4aca3eba.png)

0 commit comments

Comments
 (0)