Mov: Contributing guide

This commit is contained in:
surunzi
2018-02-14 23:49:12 +08:00
parent 38fc91538a
commit eb923bab37
2 changed files with 1 additions and 1 deletions

35
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,35 @@
# Contributing Guide
## Development Setup
[Node.js](https://nodejs.org/en/) is needed for the development of eruda.
After cloning the repo, run:
```bash
# install npm dependencies.
npm install
# copy jasmine lib from node_modules to test folder.
npm run setup
```
## Commonly used NPM scripts
```bash
# watch and auto re-build.
npm run dev
# build eruda.js and eruda.min.js
npm run build
# lint, build and test.
npm run ci
# check test coverage.
npm run cov
```
## Project Structure
- **doc**: documents.
- **eustia**: eustia extended utilties.
- **script**: webpack configuration, and some other useful scripts.
- **src**: source code, written in es2015.
- **test**: contain pages for testing.