Skip to content
New issue

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

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

Already on GitHub? # to your account

Update Contributing.md #655

Merged
merged 1 commit into from
Aug 11, 2017
Merged
Changes from all commits
Commits
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
30 changes: 17 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,28 @@

### Setup
```sh
$ git clone https://github.com/babel/minify
$ cd minify
$ npm install
$ npm run bootstrap
git clone https://github.com/babel/minify
cd minify
```

### Install

```sh
yarn
```

#### Build

To build **once**:

```sh
npm run build
yarn build
```

Or to do an incremental build in watch mode:

```sh
npm run watch
yarn watch
```

#### Lint
Expand All @@ -29,32 +33,32 @@ This project uses [prettier](https://github.com/prettier/prettier) for formattin
To check both:

```sh
npm run lint
yarn lint
```

You can also run them each individually:

```sh
# prettier
npm run format-check
yarn format-check

# eslint
npm run eslint
yarn eslint
```

##### Lint Fix

To fix formatting and auto-fixable eslint errors,

```sh
npm run fix
yarn fix
```

You can also run them each individually:

```sh
# prettier
npm run format
yarn format

# eslint
npm run eslint-fix
Expand All @@ -65,13 +69,13 @@ npm run eslint-fix
To run all tests,

```sh
npm test
yarn test
```

To run tests for a specific package,

```sh
npm test packages/babel-preset-minify
yarn test packages/babel-preset-minify
```

#### Smoke Tests
Expand Down