Skip to content

Latest commit

 

History

History
71 lines (42 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

71 lines (42 loc) · 1.64 KB
Raw

Contribution Guidelines

Thank you for considering to contribute to this project. These guidelines will help you get going with development and outline the most important rules to follow when submitting pull requests for this project.


Development

Setup

Prerequisites
Steps
  1. Clone the (forked) repository
  2. Run yarn install in the project directory

Building

yarn build

This will run the TypeScript compiler and write the JavaScript output to dist.

Linting

yarn lint

This will run tslint to check for code style errors.

Running Tests

yarn test

This will run automated tests with jest. There are also some end-to-end tests which can be run with yarn test:e2e.

Note: The E2E tests expect a built version of the package to be present in dist/ so it's best to run yarn build first.


Submitting Changes

To get changes merged, create a pull request. Here are a few things to pay attention to when doing so:

Commit Messages

The summary of a commit should be concise and worded in an imperative mood.
...a what mood? This should clear things up: How to Write a Git Commit Message

Code Style

It is required that you follow the existing code style. Use yarn lint to check.

Tests

If it makes sense, writing tests for your PRs is always appreciated and will help get them merged.