forked from reactjs/react-modal
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[chore] added documentation for development.
- Loading branch information
Showing
2 changed files
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Development | ||
|
||
`react-modal` uses `make` to build and publish new versions and documentation. | ||
|
||
It works as a checklist for the future releases to keep everything updated such as | ||
`CHANGELOG.md`, `package.json` and `bower.json` and so on. | ||
|
||
The minimun works as a normal `npm script`. | ||
|
||
## Usage | ||
|
||
Once you clone `react-modal`, you can run `sh bootstrap.sh` to check | ||
and download dependencies not managed by `react-modal` such as `gitbook-cli`. | ||
|
||
It will also show information about the current versions of `node`, `npm`, | ||
`yarn` and `jq` available. | ||
|
||
## List of `npm` commands: | ||
|
||
$ npm start -s or yarn start # to run examples | ||
$ npm run tests | ||
$ npm run lint | ||
|
||
## List of `make` commands: | ||
|
||
$ make help # show all make commands available | ||
$ make deps # npm install, gitbook plugins... | ||
$ make serve # to run examples | ||
$ make tests # use when developing | ||
$ make tests-ci # single run | ||
$ make lint # pass lint | ||
$ make publish # execute the entire pipeline to publish | ||
$ make publish-docs # execute the pipeline for docs |