Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 1.32 KB

Contributing

This repo uses Lerna to manage it as a monorepo and Conventional Commits so we can automatically generate a changelog and determine the next semver version for each package.

Prerequisites

In order to work on this repository the following dependencies are required:

Getting Started

The setup only requires you to install Node dependencies. This can be done with

yarn

Creating a commit

As stated above, this repository uses Conventional Commits for commits. To make it easier to conform to the spec we use the Commitizen package that is hooked into git commit. This will make sure you create a commit that conforms to the spec.

The commit message guildelines are described in full on the Conventional Commits website. The commitlint package also contains documentation on the specification.

# Commit your files
# Make sure to not use `-m "message"` to add your message. You will be prompted for this.
git commit

Publishing packages

TODO