Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

42 lines (25 loc) · 1.42 KB
Raw

Contributing

New contributions are welcomed. Follow this guide if you want to make one.

Make a pull request

Follow Github guide to fork a repo and create a pull request.

All bug fixes and new features should go to the master branch.

Commit messages

Commit messages should describe what have been changed and why. The first line should be wrapped to 50 characters, the second one should be blank. All other lines should be wrapped to 72 characters.

Code style and static analysis

Before submitting pull request, make sure your code passes all code style and static analysis checks. To do so, run:

npm run lint

Tests

Make sure all tests are passing before submitting pull request:

npm test

If you are fixing the bug, add a test that fails without your patch and passes with it. If you are adding a feature, write a test for it.

Issues reporting

When submitting an issue please do following:

  1. Search for same issues on github in order to prevent duplicates
  2. Provide the most detailed issue description so we will additional info to work with

Note that if no response for contributors questions will be provided in 1 week then issue may be considered as irrelevant/resolved and may be closed.