Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 1.08 KB

Contributing to Warthog

Thank you for your interest in contributing to Warthog!

Development setup

To get a basic development environment for Node.js and Docker Compose up and running, first make sure you have Git, Pnpm, Node.js (see our package.json for minimum required version) installed and working properly.

Dependencies

Consult pnpm docs to find out more about how we manage Warthog dependencies.

# Installing all dependencies
pnpm install

Running the test suite

pnpm run test

Running the linter

pnpm exec eslint . --fix

Commit format

There is a git hook that will have been installed via husky in charge of checking the syntax in the commits by using commitlint.

For more details check the file .husky/commit-msg