Skip to content

Commit

Permalink
Setup Travis, add build script, init contributing docs (#45)
Browse files Browse the repository at this point in the history
* Add Travis

* Add yarn.lock

* Temporarily disable Node 6 in Travis

* Add contributing docs

* Add build script
  • Loading branch information
jamiebuilds authored and devongovett committed Dec 6, 2017
1 parent 67cd3b0 commit 90f69ff
Show file tree
Hide file tree
Showing 5 changed files with 5,193 additions and 2 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
node_modules/
.DS_Store
yarn.lock
package-lock.json
test/dist
test/input
Expand Down
8 changes: 8 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
language: node_js
node_js:
# TODO: Run Babel on tests so that async-await works in Node 6
# - '6'
- '8'
cache: yarn
script: yarn test
sudo: false
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing

## Overview

* `yarn install` - install all dependencies
* `yarn build` - run src/ through [babel] into lib/
* `yarn test` - run all tests in repo
* `yarn format` - run [prettier] on all files

## Getting Started

To get started with the project:

You'll need [Git], [Node], and [Yarn] installed. Then clone the repository:

```js
git clone git@github.com:parcel-bundler/parcel.git && cd parcel
```

Run Yarn:

```js
yarn install
```

Run tests:

```js
yarn test
```

[babel]: http://babeljs.io/
[prettier]: https://prettier.io/
[git]: https://git-scm.com/
[node]: https://nodejs.org/
[yarn]: https://yarnpkg.com/
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
},
"scripts": {
"test": "cross-env NODE_ENV=test mocha",
"prepublish": "babel src -d lib"
"build": "babel src -d lib",
"prepublish": "yarn build"
},
"bin": {
"parcel": "bin/cli.js"
Expand Down
Loading

0 comments on commit 90f69ff

Please sign in to comment.