CONTRIBUTING.md

How to Develop

• Commands
  • Install
  • Build
  • Test
  • Format
    • Check
    • Fix
  • Deploy
    • Login
    • Deploy a version
• Pull requests
• Branch Name Convention
• Commit Convention
  • Format
  • Version Types

Commands

Install

yarn install

Build

Build all packages in the correct order:

yarn build

Test

Run all tests

yarn test

Format

Check

To check that the format is correct is the whole codebase

yarn format:check

Fix

To auto fix all formatting issues

yarn format:fix

Deploy

Login

All of those commands depends on yarn. So you need to be logged into NPM with yarn

yarn npm login

Deploy a version

To deploy a specific version

yarn deploy -v $VERSION
# Example: yarn deploy -v 0.2.0-beta.3

And if you want to add an NPM tag (like next)

yarn deploy -v $VERSION --tag $TAG
# Example: yarn deploy -v 0.2.0-beta.3 --tag next

Pull requests

Before opening a PR, we should need to open an issue so that you can get a taskId (otherwise you can try to guess the next PR id).

All changes are made in a specific branch. When you are done with your changes you can create a pull request.

Each pushed commit will trigger a Github Action that will run tests. All tests has to pass before it is possible to merge a pull request.

Branch Name Convention

task/{taskId}-{taskDescription}

Commit Convention

In order to determine which version type a package should be released with and to be able to generate release notes, commits has to follow a certain format.

Format

#{taskId}@{versionType}: {description}

Version Types

You can pick between:

• dev
• patch
• minor
• major