mirror of
https://github.com/liriliri/eruda.git
synced 2026-05-20 08:47:20 +08:00
Mov: Contributing guide
This commit is contained in:
35
.github/CONTRIBUTING.md
vendored
Normal file
35
.github/CONTRIBUTING.md
vendored
Normal 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.
|
||||
Reference in New Issue
Block a user