Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 2.09 KB
Raw

For Contributors

Welcome to our project! Before you start contributing please get familiar at least with HOWTO contribute section.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Table of contents

HOWTO contribute

  1. To request changes, a user SHOULD log an issue on the issue tracker.
  2. The user or Contributor SHOULD write the issue by describing the problem they face or observe.
  3. Before making changes Contributor SHOULD fork this project.
  4. To submit a patch, a Contributor MUST create a pull request back to the project.
  5. To submit a patch, a Contributor SHOULD reference the issue in the commit message.
  6. To submit a patch, the commit message redacted by a Contributor SHOULD be compliant with Conventional Commits specification.

(this section was inspired by ZMQ C4 contract)

Commit Message Format

We stick to Conventional Commits specification i.a. to generate changelog automatically.

Here is a list of valid types and user friendly description from Angular.

If you need more examples check commits on master branch.

Installing requirements

Run

yarn install

This will also install all git hooks from .githooks directory