Questions, bug reports, feedback, etc. can be sent to our Github Issues.
Pull requests are welcome.
The CLI depends heavily on ionic-app-lib (on Github), which provides a library for working with Ionic apps and is the core of the Ionic CLI and Lab. When developing, you will likely be committing to both the CLI and App Lib repos.
-
Fork both
ionic-cliandionic-app-liband then clone:$ git clone [email protected]:[you]/ionic-cli.git $ git clone [email protected]:[you]/ionic-app-lib.git
-
Install the dependencies of both with
npm install. -
Link the App Lib in your global
node_modulesdirectory:$ cd ionic-app-lib $ npm link -
Tell the CLI to use the globally linked
ionic-app-libpackage:$ cd ionic-cli $ npm link ionic-app-lib
develop Development branch. You should branch off here.
master Stable branch.
We develop changes in the develop branch of both repos. You should make your
changes in the develop branch and then create a pull request off of our
develop branch. Once the code is accepted, we will create a tag for the
release and publish it to NPM. Once in NPM, the code is considered "stable" and
is merged into master.
-
Create a new local branch.
$ git checkout -b name-of-feature develop
-
Commit your changes.
-
Push up your changes to your fork with
git push origin name-of-feature. -
Before submitting a pull request, run the linter and tests, fixing any errors.
$ gulp lint $ gulp test -
Submit your pull request.