Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (20 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.35 KB

Contributing

Thanks for your interest in contributing!

Get started

  1. Fork and clone this repository
  2. $ yarn install to install dependencies
  3. Create a branch for your Pull Request

While you can work directly on your own version of master, it is recommended you work on a different branch to always keep master stable.

Development

  1. $ yarn build -- --watch to watch over your files and bundle on save
  2. $ npm link to make bs accessible via command line
  3. $ bs to test out your changes

Committing and Pushing changes

This project uses semantic-release to do automatic releases and generate a changelog based on the commit history. So 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 committed>
  2. $ yarn cz

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