CONTRIBUTING.md

Contributing to HaTs

Thank you for your interest in contributing to HaTs! We welcome PRs.

• First steps - Features
• First steps - Fixes
• Creating a PR
• Submitting a PR

First steps - Features

If your PR proposes a new feature start a discussion with the HaTs community first.

First steps - Fixes

If your PR proposes a bug fix, create an issue first.

Creating a PR

1. Fork this repo to your own GitHub

2. Remove any existing hats-cli global installations on your machine

   npm uninstall -g hats-cli

3. Clone your fork to your machine

   git clone https://github.com/<your-org>/hats-cli.git
   cd hats-cli
   

4. Install deps and build

   npm i && npm run build
   

   Note: you'll need to run npm run build to view your changes

5. Symlink your local dev version (this enables the hats command to run your local build)

   npm link
   

Submitting a PR

1. Pull master if there have been any commits since your fork

2. Ensure npm run test passes, and you're good to go 🚀