Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 1.98 KB

Contributing 🔥

Suggestions and pull requests are highly encouraged! Open issues are a good place to start.

Required reading 📓

  • You will need to be familiar with npm, webpack and jest.
  • The extension can be build and loaded into Chrome or Firefox locally for QA

Getting started 🔌

Clone the repo and install dependencies:

git clone git@github.com:iamogbz/chrome-alt-tabs.git
cd chrome-alt-tabs
npm install

While making changes or switching branches, run build-watch to auto build new code:

npm run build-watch

Start coding!

Check changes 🛠️

Load or reload it in your browser of choice to try out your changes. You will have to reload the extension after making changes, as browsers do not auto reload extensions yet.

Chrome Firefox
chrome://extensions about:debugging#addons
Check the Developer mode checkbox
Click on the Load unpacked extension button Click on the Load Temporary Add-on button
Select the folder chrome-alt-tabs/dist Select the file chrome-alt-tabs/dist/manifest.json

Writing tests 🚧

Linting and testing is run on commits. To add tests for a file, create a [name].test.js file in the ./tests folder, with the same relative path as the file in the ./src folder being tested.

npm run test # to run all tests
npx jest "filename" # to run specific test

Happy contributing! 🎉