PT Package Shared Helpers

Introduce the project

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• GNU make
• bumpversion - from here
• yarn - for package management

Installing

• Run make install to install node_modules

Running the tests

This project uses mocha

• Invoke tests with make test
• They will be run automatically as pre-push hook through Husky
• You can use make cover to check your code coverage

Coding style

This project enforces the Airbnb Javascript Style Guide

• Exceptions and modifications are shown in .eslintrc.js
• Linting and editor configuration is handled automatically through .editorconfig, .eslintrc.js and prettier.config.js
• Before committing your code, you should run yarn prettier to cleanup your code (although some linting will still be enforced on git commit)
• Changelog generation performed through Conventional Changelog

Deployment

TODO