Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 1.34 KB

Contributions

🎉 Thanks for considering contributing to this project! 🎉

These guidelines will help you send a pull request.

If you're submitting an issue instead, please skip this document.

If your pull request is related to a typo or the documentation being unclear, please click on the relevant page's Edit button (pencil icon) and directly suggest a correction instead.

This project was made with ❤️. The simplest way to give back is by starring and sharing it online.

Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.

Development process

First fork and clone the repository. If you're not sure how to do this, please watch these videos.

Run:

npm install

Make sure everything is correctly setup with:

npm test

Before submitting a pull request make sure testing, linting and formatting are passing with:

npm test
npm run format
npm run lint

After submitting the pull request, please make sure the Continuous Integration checks are passing.

Releasing

  1. Merge the release PR
  2. Switch to the default branch git checkout master
  3. Pull latest changes git pull
  4. Publish the package npm publish