Skip to content

Commit 90f69ff

Browse files
jamiebuildsdevongovett
authored andcommitted
Setup Travis, add build script, init contributing docs (#45)
* Add Travis * Add yarn.lock * Temporarily disable Node 6 in Travis * Add contributing docs * Add build script
1 parent 67cd3b0 commit 90f69ff

5 files changed

Lines changed: 5193 additions & 2 deletions

File tree

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
node_modules/
22
.DS_Store
3-
yarn.lock
43
package-lock.json
54
test/dist
65
test/input

.travis.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
language: node_js
2+
node_js:
3+
# TODO: Run Babel on tests so that async-await works in Node 6
4+
# - '6'
5+
- '8'
6+
cache: yarn
7+
script: yarn test
8+
sudo: false

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
## Overview
4+
5+
* `yarn install` - install all dependencies
6+
* `yarn build` - run src/ through [babel] into lib/
7+
* `yarn test` - run all tests in repo
8+
* `yarn format` - run [prettier] on all files
9+
10+
## Getting Started
11+
12+
To get started with the project:
13+
14+
You'll need [Git], [Node], and [Yarn] installed. Then clone the repository:
15+
16+
```js
17+
git clone git@github.com:parcel-bundler/parcel.git && cd parcel
18+
```
19+
20+
Run Yarn:
21+
22+
```js
23+
yarn install
24+
```
25+
26+
Run tests:
27+
28+
```js
29+
yarn test
30+
```
31+
32+
[babel]: http://babeljs.io/
33+
[prettier]: https://prettier.io/
34+
[git]: https://git-scm.com/
35+
[node]: https://nodejs.org/
36+
[yarn]: https://yarnpkg.com/

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@
5454
},
5555
"scripts": {
5656
"test": "cross-env NODE_ENV=test mocha",
57-
"prepublish": "babel src -d lib"
57+
"build": "babel src -d lib",
58+
"prepublish": "yarn build"
5859
},
5960
"bin": {
6061
"parcel": "bin/cli.js"

0 commit comments

Comments
 (0)