Contributing to Ignite CLI

December 17, 2025 ยท View on GitHub

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 pnpm 10.9.0

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

Requirements

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

Getting Started

  1. Fork and then clone the repo (git clone git@github.com:<YOURGITHUBUSER>/ignite.git)
  2. CD into the directory (cd ignite)
  3. Uninstall npm version (pnpm remove ignite-cli -g)
  4. Pull all package dependencies (pnpm install)
  5. Link the local binary (pnpm 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!

Source Code

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

How to Build and Run App

$ cd ~/your/projects
$ ignite new HackingOnIgnite

Testing the App

We use Jest for testing.

To run tests from the ignite folder:

$ pnpm run test

To Run Lint from ignite:

$ pnpm run lint