Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

50 lines (32 loc) · 1.59 KB
Raw

Contributing

This project uses Bun! If you are on Windows, please refer to this post on how to make it work on your machine.

Install dependencies

bun install

Build the project

bun run build

OR

bun run build:firefox

Manual Installation:

Chrome
  • Open your Chrome browser and navigate to chrome://extensions/.
  • Enable "Developer mode" in the top right corner.
  • Click on "Load unpacked" and select the github-repo-size-extension folder inside the github-repo-size directory (generated after running bun run build:firefox).
Firefox
  • Open your Firefox browser and navigate to about:debugging#/runtime/this-firefox.
  • Click on "Load Temporary Add-on…" and select the github-repo-size-extension folder inside the github-repo-size directory (generated after running bun run build).

Please format and fix any linting problems in the project before creating a PR.

bun run format
bun run lint

Most of the business logic for this extension happens inside the src/scripts/ folder. If you are looking to make changes, this is most likely the place to start.

Docs

Visit the docs page for information about specific functions. There are even a few examples.