Contributing to Ignite CLI

We welcome all contributors to Ignite CLI! This contributing guide will help you get up and running to submit your first pull request.

Before submitting a pull request, you will want to make sure that your branch meets the following requirements:

Working on Ignite CLI requires Yarn v1.

Everything works on iOS/Android
Jest tests pass in the root folder (yarn test)
New tests are included for any new functionality
Code is compliant with our linter and prettier (yarn format && yarn lint)
Branch has already been synced with the upstream repo and any merge-conflicts have been resolved.

Requirements

Node (reasonably recent version)
Yarn (while you can use Ignite CLI without Yarn, we require it for contributors)

Fork and then clone the repo (git clone git@github.com:<YOURGITHUBUSER>/ignite.git)
CD into the directory (cd ignite)
Uninstall npm version (yarn global remove ignite-cli)
Pull all package dependencies (yarn)
Link the local binary (yarn link)

Test it out:

$ ignite --version
<current version here>
$ which ignite
/usr/local/bin/ignite
$ ignite new UberForHeadLice
...

Now you're ready to check out a new branch and get hacking on Ignite CLI!

To get familiarized with Ignite CLI's source code, read the Tour of Ignite CLI's source code (TODO! currently out of date).

$ cd ~/your/projects
$ ignite new HackingOnIgnite

We use Jest for testing.

To run tests from the ignite folder:

$ yarn test

To Run Lint from ignite:

$ yarn lint