website-deploy/CONTRIBUTING.md

A simple utility to deploy a static website to [s3-bucket, lambda, ...]

# Contribution Guide

This document describes how to contribute to this repository.

## Pre-requisite

- Node.js >= v8
- git

## Installation

First the fork this repository and do a checkout of source code from your fork as below:

```console
git clone https://github.com/<YOUR_GITHUB_ID>/website-deploy
```

Once the repository is cloned, please navgate to the project folder.

```console
npm install
```

This will install the dependencies and you are now ready to contribute.

## Commit

There are precommit and prepush hooks atttached to this repository. These hooks will run lint, prettier and unit test cases before any commit and push.

Please comply here.

## PR

Once you follow all the above, your PR should land safely in the main repository.