Skip to content

Latest commit

聽

History

History
86 lines (54 loc) 路 2.31 KB

CONTRIBUTING.md

File metadata and controls

86 lines (54 loc) 路 2.31 KB
Raw

Genpwd Maker Contributing Guide

Hi! We're Really excited that you are interested in contributing to Genpwd. Before submitting your contribution, please make sure to take a moment and Read through the following guidelines:

Pull Request Guidelines

  • Checkout a topic branch from the relevant branch, e.g. main, and merge back against that branch.

  • If adding a new feature:

    • Provide a convincing Reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.

  • If fixing bug:

    • Provide a detailed description of the bug in the PR. Live demo preferred.

  • It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.

  • Commit messages must be matched by the following regex:

/^(feat|fix|style|refactor|perf|test|workflow|build|ci|chore|types)(\(.+\))?: .{1,50}/

Development Setup

You will need pnpm:

npm install -g pnpm

After cloning the repo, run:

pnpm install

Setup Dev Environment

Chrome/Edge

pnpm dev

After executing the above command, visit chrome extensions page chrome://extensions/, and click Load unpacked button, then select the build/chrome-mv3-dev folder in the project root directory, and try modifying the source code. You'll get live update.

Alternatively, you can open a new CLI window and run the following command, this will open a clean chrome window.

pnpm start

Firefox

pnpm dev:firefox

After executing the above command, visit firefox debugging page about:debugging#/runtime/this-firefox, and click Load Temporary Add-on... button, then select the build/firefox-mv2-dev/manifest.json file in the project root directory, and try modifying the source code. You'll get live update.

Alternatively, you can open a new CLI window and run the following command锛宼his will open a clean firefox window.

pnpm start:firefox

Get build target(.zip)

Chrome/Edge: build/chrome-mv3-prod.zip

pnpm build
pnpm package

Firefox: build/firefox-mv2-prod.zip

pnpm build:firefox
pnpm package:firefox