Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.37 KB

Contributing

If you want to contribute please follow the guide in this file.

Pull request

  • Create your branch from the next branch
  • Ensure that the changes are tested and documented
  • This project uses commitizen and conventional changelog. Please use both to ensure that the changes are listed correctly and the commits can be parsed
    • If you don't have it installed, please follow the guidline to install both commitizen and cz-conventional-changelog
    • When this is done you can use git cz to create commit messages that are valid for this project

Issues

  • Please include the browser and operating system if this is a bug
    • A snippet of example code helps a lot, a link to the repo with the issue helps even more
    • If the issue can be seen live please provide a link
    • Include info about your development environment
  • Please make sure to describe the feature if its something that you want to have added

Development

  • Read the Getting Started to setup the project locally
  • To start it run npm start