Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 972 Bytes

CONTRIBUTING.md

File metadata and controls

52 lines (32 loc) · 972 Bytes
Raw

Contributing

Thank you for your contribution. Here are a set of guidelines for contributing to the taskd project.

Just follow these simple guidelines to get your PR merged ASAP.

Installing

$ git clone https://github.com/rucas/shh

Tests

Standard

Standard is the linter of choice for this repo. To run lint checks:

$ yarn lint

Jest

Jest is the test runner of choice for this repo. To run tests:

$ yarn test

To run a specific test:

$ yarn test -t '<regex>'

More info here.

git-hooks

Husky is set-up to run on:

  • pre-commit, runs yarn lint

  • pre-push, runs yarn test

Submitting a Patch

  1. Create an issue
  2. Fork the repo
  3. Run tests
  4. Push commits to your fork and submit a PR