CONTRIBUTING.md

Contributing

1. Check out the issues
2. Fork this repository
3. Clone your fork
4. Add the upstream project (this one) as a git remote:

   $ git remote add upstream [email protected]:rpearce/react-medium-image-zoom.git
   $ git fetch upstream
   $ git rebase upstream/main
   

5. Check out a feature branch

   $ git checkout -b my-feature
   

6. Make your changes
7. Push your branch to your GitHub repo

   $ git push origin my-feature
   

8. Create a pull request from your branch to this repo's main branch
9. When all is merged, pull down the upstream changes to your main

   $ git checkout main
   $ git fetch upstream
   $ git rebase upstream/main
   

10. Delete your feature branch (locally and then on GitHub)

    $ git branch -D my-feature
    $ git push origin :my-feature
    

Testing

Tests are located in the test/ folder. Here's how to run them:

$ npm run test

To test in watch mode:

$ npm run test --watch

To generate a local coverage report:

$ npm run test --coverage
$ open coverage/lcov-report/index.html