Skip to content

Commit 91a39d5

Browse files
authored
docs: update CONTRIBUTING.md (vuejs#2493)
1 parent 7e29900 commit 91a39d5

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

.github/CONTRIBUTING.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,14 @@ This project uses a monorepo setup that requires using [Yarn](https://yarnpkg.co
44

55
``` sh
66
# Install all dependencies.
7-
yarn install
7+
yarn
88

99
# Serves VuePress' own docs with itself.
1010
yarn dev
1111

1212
# Build VuePress' own docs with itself.
1313
yarn build
1414

15-
# Execute all the test suites.
16-
yarn test
17-
1815
# Clean dependencies.
1916
yarn clean
2017

@@ -24,7 +21,15 @@ yarn boot
2421

2522
## Testing Setup
2623

27-
> TODO
24+
VuePress leverages [jest](https://jestjs.io/) for its tests, testing process depends on some setup located at [scripts/test.js](../scripts/test.js).
25+
26+
```bash
27+
# Execute all the test suites.
28+
yarn test
29+
30+
# Execute tests under specfic package.
31+
yarn test -p=core ## OR --package=core
32+
```
2833

2934
## Core Packages
3035

scripts/test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const args = minimist(rawArgs)
88
let regex
99
const debug = !!args['inspect-brk']
1010

11-
if (args.p) {
11+
if (args.p || args.package) {
1212
const packages = (args.p || args.package).split(',').join('|')
1313
regex = `.*@vuepress/(${packages}|plugin-(${packages}))/.*\\.spec\\.(js|ts)$`
1414
const i = rawArgs.indexOf('-p')

0 commit comments

Comments
 (0)