Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 1.79 KB

File metadata and controls

64 lines (43 loc) · 1.79 KB

Contributing

Questions, bug reports, feedback, etc. can be sent to our Github Issues.

Pull requests are welcome.

Local Development

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.

  1. Fork both ionic-cli and ionic-app-lib and then clone:

    $ git clone [email protected]:[you]/ionic-cli.git
    $ git clone [email protected]:[you]/ionic-app-lib.git
  2. Install the dependencies of both with npm install.

  3. Link the App Lib in your global node_modules directory:

    $ cd ionic-app-lib
    $ npm link
  4. Tell the CLI to use the globally linked ionic-app-lib package:

    $ cd ionic-cli
    $ npm link ionic-app-lib

Git Branches

develop Development branch. You should branch off here.

master Stable branch.

Usage

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.

Pull Requests

  1. Create a new local branch.

    $ git checkout -b name-of-feature develop
  2. Commit your changes.

  3. Push up your changes to your fork with git push origin name-of-feature.

  4. Before submitting a pull request, run the linter and tests, fixing any errors.

    $ gulp lint
    $ gulp test
  5. Submit your pull request.