contributor.md

Installation guide

• Install Git : https://git-scm.com/

• Install Node.js : https://nodejs.org

• Clone the project :

  $ git clone https://github.com/DWTechs/GitBranchValidator

• Install project dependencies :

  $ cd <project-directory>
  $ npm i

Workflow

• create a branch following these instructions

• run the library :

  $ node ./bin

• test the library :

  $ npm run test

• commit your work following those simplified conventional commits rules :

Docker

Launch with docker

build image :

$ cd GitBranchValidator/
$ docker-compose up -d

test lib :

$ cd GitBranchValidator/
$ docker-compose run gitbranchvalidator

Folders

• bin/
• lib/
• tests/

Stack

Purpose	Choice	Motivation
repository	Github	the world’s largest community of developers to discover, share, and build better software
package manager	npm	default node.js package manager
unit testing	Jest	delightful testing with a focus on simplicity