A basic CONTRIBUTING.md

CONTRIBUTING.md

How to contribute

1. fork this repository

2. clone the forked version

git clone git@github.com:<your_username>/<repo_name>.git

3. install dependencies

npm i

or

yarn install

4. run

npm start

or

yarn start

5. create a new branch

git checkout -b feature/featureName

or

git checkout -b fix/bugFixed

6. make your changes

7. run with your changes

8. run tests with your changes

9. build and run build

10. commit your changes and push your branch

git add *
git commit -m "cool message that describes what you've done"
git push origin feature/featureName

11. open a pull request (PR)

12. have your PR merged 😎