Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.2 KB
Raw

Contributing

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Project setup

  1. Fork and clone the repo
  2. $ npm install to install dependencies
  3. $ npm run validate to validate you've got it working
  4. Create a branch for your PR

Testing workflow

Have a look at test/README.md to see how testing works. Run npm run watch:test while developing. Have fun! :)

Editor setup

Please install editorconfig plugin for your preferred editor.

Committing and Pushing changes

We follow a convention for commit messages. Please follow this convention for your commit messages.

You can use commitizen to help you to follow the convention

Once you are ready to commit the changes, please use the below commands

  1. git add <files to be comitted>
  2. $ npm run commit

... and follow the instruction of the interactive prompt.