From 8d8759959f4d71094ba9389b677cd871a45400d0 Mon Sep 17 00:00:00 2001 From: Bruno Dias Date: Sun, 18 Jun 2017 23:43:19 -0300 Subject: [PATCH] [chore] added documentation for development. --- docs/SUMMARY.md | 3 +++ docs/dev/README.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 docs/dev/README.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 8d8a8540..1ed99909 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,6 +1,9 @@ # Summary * [Read Me](/README.md) + +* [Development](dev/README.md) + * [Styles](styles/README.md) * [Using CSS Classes](styles/classes.md) * [Overriding Defaults](styles/defaults.md) diff --git a/docs/dev/README.md b/docs/dev/README.md new file mode 100644 index 00000000..cd22decd --- /dev/null +++ b/docs/dev/README.md @@ -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