CONTRIBUTING.md

How to contribute to the Jobhub Chrome extension

Thanks for your interest on contributing to Jobhub!
Here are a few general guidelines on contributing and reporting bugs that we ask you to take a look first.
Notice that all of your interactions in the project are expected to follow our Code of Conduct.

Reporting Issues

If your issue wasn't already reported or fixed in our issue board, you can submit it using this template.

If you find a security bug, do not report it through GitHub.
Please send an e-mail to alexander.bratyshkin@mail.mcgill.ca or camilo.e.garcia@mail.mcgill.ca instead.

Sending Pull Requests

If your enhancement or bug fix wasn't already proposed or fixed in our issue board, you can submit it using this template.

The basic things every PR must have are the following:

• an issue atttached to it so that the team can discuss before a solution is implemented
• a set of tests that validate the bug is fixed or the enhancement is functional

How to setup

1. Clone the repo and install the dependencies

   git clone https://github.com/scrum-gang/jobhub-chrome.git
   cd jobhub-chrome
   npm install

2. Start the Bucklescript watcher to compile ReasonML ./src/*.re into Javascript ./lib/js/*.js

   npm start

3. Start the Webpack watcher to bundle ./lib/js/*.js into ./build/index.js

   npm run webpack-dev

4. Start the Jest watcher to continously test your changes

   npm test

5. If you haven't done so previously, unpack the extension locally in your browser.
   Note that you only really need to run this step once.