CONTRIBUTING.md

Develop and contribute

Setup

git clone git@github.com:frinyvonnick/gitmoji-changelog.git

cd gitmoji-changelog && yarn

We are using lerna and yarn workspaces to split the library in modules:

• gitmoji-changelog-cli - the full-featured command line interface
• gitmoji-changelog-core - the core lib generating changelog
• gitmoji-changelog-markdown - the markdown changelog file writer

Usage locally

node [path-to-gitmoji-changelog-folder]/packages/gitmoji-changelog-cli/src/index.js

Run unit tests

yarn test
# or
yarn test --watch

Run e2e tests

yarn test:e2e

Run linter

We are using airbnb-base as linter:

yarn lint