Skip to content

docs: update CONTRIBUTING.md #2493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 20, 2020
Merged

docs: update CONTRIBUTING.md #2493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,14 @@ This project uses a monorepo setup that requires using [Yarn](https://yarnpkg.co

``` sh
# Install all dependencies.
yarn install
yarn

# Serves VuePress' own docs with itself.
yarn dev

# Build VuePress' own docs with itself.
yarn build

# Execute all the test suites.
yarn test

# Clean dependencies.
yarn clean

Expand All @@ -24,7 +21,15 @@ yarn boot

## Testing Setup

> TODO
VuePress leverages [jest](https://jestjs.io/) for its tests, testing process depends on some setup located at [scripts/test.js](../scripts/test.js).

```bash
# Execute all the test suites.
yarn test

# Execute tests under specfic package.
yarn test -p=core ## OR --package=core
```

## Core Packages

Expand Down
2 changes: 1 addition & 1 deletion scripts/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const args = minimist(rawArgs)
let regex
const debug = !!args['inspect-brk']

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