Skip to content

Commit 8d87599

Browse files
committed
[chore] added documentation for development.
1 parent aaeb310 commit 8d87599

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

docs/SUMMARY.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Summary
22

33
* [Read Me](/README.md)
4+
5+
* [Development](dev/README.md)
6+
47
* [Styles](styles/README.md)
58
* [Using CSS Classes](styles/classes.md)
69
* [Overriding Defaults](styles/defaults.md)

docs/dev/README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Development
2+
3+
`react-modal` uses `make` to build and publish new versions and documentation.
4+
5+
It works as a checklist for the future releases to keep everything updated such as
6+
`CHANGELOG.md`, `package.json` and `bower.json` and so on.
7+
8+
The minimun works as a normal `npm script`.
9+
10+
## Usage
11+
12+
Once you clone `react-modal`, you can run `sh bootstrap.sh` to check
13+
and download dependencies not managed by `react-modal` such as `gitbook-cli`.
14+
15+
It will also show information about the current versions of `node`, `npm`,
16+
`yarn` and `jq` available.
17+
18+
## List of `npm` commands:
19+
20+
$ npm start -s or yarn start # to run examples
21+
$ npm run tests
22+
$ npm run lint
23+
24+
## List of `make` commands:
25+
26+
$ make help # show all make commands available
27+
$ make deps # npm install, gitbook plugins...
28+
$ make serve # to run examples
29+
$ make tests # use when developing
30+
$ make tests-ci # single run
31+
$ make lint # pass lint
32+
$ make publish # execute the entire pipeline to publish
33+
$ make publish-docs # execute the pipeline for docs

0 commit comments

Comments
 (0)