Contributing

May 9, 2020 ยท View on GitHub

Development Environment

There is really not much too it. As long as you have some experience with:

After you fork this repository, all you have to do is run:

yarn install

Now you can party ๐ŸŽ‰๐ŸŽ‰ and do some work. ๐Ÿ™Œ

Guidelines

Please, don't skip git hooks:

  • we all have to use conventional commit messages for semantic release to work
  • we all have to fix eslint errors before we commit new changes

Thank you for considering your help to this repository. ๐Ÿ˜Š

Commit Guidelines

Commit TypeTitleDescriptionEmojiReleaseInclude in changelog
featFeaturesA new featureโœจminortrue
fixBug FixesA bug Fix๐Ÿ›patchtrue
docsDocumentationDocumentation only changes๐Ÿ“špatchtrue
styleStylesChanges that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)๐Ÿ’Ž-true
refactorCode RefactoringA code change that neither fixes a bug nor adds a feature๐Ÿ“ฆ-true
perfPerformance ImprovementsA code change that improves performance๐Ÿš€patchtrue
testTestsAdding missing tests or correcting existing tests๐Ÿšจ-true
buildBuildsChanges that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)๐Ÿ› patchtrue
ciContinuous IntegrationsChanges to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)โš™๏ธ-true
choreChoresOther changes that don't modify src or test filesโ™ป๏ธpatchtrue
revertRevertsReverts a previous commit๐Ÿ—‘-true