mirror of
https://github.com/liriliri/eruda.git
synced 2026-05-20 08:47:20 +08:00
chore: small changes
This commit is contained in:
32
.github/CONTRIBUTING.md
vendored
32
.github/CONTRIBUTING.md
vendored
@@ -1,32 +0,0 @@
|
|||||||
# 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
|
|
||||||
npm run build
|
|
||||||
# lint, build and test.
|
|
||||||
npm run ci
|
|
||||||
```
|
|
||||||
|
|
||||||
## Project Structure
|
|
||||||
|
|
||||||
- **doc**: documents.
|
|
||||||
- **build**: webpack configuration, and some other useful scripts.
|
|
||||||
- **src**: source code, written in es2015.
|
|
||||||
- **test**: contain pages for testing.
|
|
||||||
@@ -82,4 +82,4 @@ For more detailed usage instructions, please read the documentation at [eruda.li
|
|||||||
|
|
||||||
## Contribution
|
## Contribution
|
||||||
|
|
||||||
Read [Contributing Guide](.github/CONTRIBUTING.md) for development setup instructions.
|
Read [Contributing Guide](https://eruda.liriliri.io/docs/contributing.html) for development setup instructions.
|
||||||
|
|||||||
Reference in New Issue
Block a user