Contributing

This page contains the contributing guidelines.

Setup

Prerequisites

Install Node.js. The version specified in .nvmrc is guaranteed to work, but newer versions will likely work too.

Install Yarn: npm i -g yarn

Note that the doc site (under the docs folder) has a newer version of Node, with a separate installation and build commands.

Project setup

Fork the just repo from https://github.com/microsoft/just, then clone your fork.

git clone <your-clone-url>
cd just

Local development

Install and build

$ yarn
$ yarn build

Run and test

To run this with Node:

$ yarn start

To run tests and/or lint:

$ yarn test
$ yarn lint

Before making a PR

After committing your changes, you'll need to create a Beachball change file. From the repo root, run:

$ yarn change