Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

70 lines (43 loc) · 1.54 KB
Raw

Contributing

Thank you for your interest in contributing to TTV LOL PRO! This web extension is coded in TypeScript and utilizes the webextension-polyfill npm package. The build process is handled by Parcel, and we use the @parcel/config-webextension plugin.

Requirements

Installation

To install the dependencies, run the following command:

npm install

Development

To start the development server, run the following command:

  • For Firefox:
npm run dev:firefox
  • For Chromium-based browsers:
npm run dev:chromium

This will start a server on localhost:1234 and will watch for changes in the src folder.

Build

To build the extension, run the following command:

  • For Firefox:
npm run build:firefox
  • For Chromium-based browsers:
npm run build:chromium

Lint

To check for linting errors, run the following command:

npm run lint

To fix linting errors, run the following command:

npm run lint:fix

Pull requests

We appreciate pull requests! If you plan to make significant changes, we recommend opening an issue first to discuss your proposed modifications.

We welcome contributions from developers of all skill levels, so don't hesitate to get involved. If you have any questions or need assistance, please feel free to reach out to us. Happy coding!