Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (29 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.08 KB

Contributing

Thanks for your interest in improving GitHub Directory Downloader!

Development

Requires Node.js (>= 20.9) and pnpm (corepack enable picks the version from package.json).

pnpm install
pnpm dev          # watch build into ./dist

Then load ./dist as an unpacked extension from chrome://extensions (Developer mode → Load unpacked).

Localization

User-facing strings live in src/_locales/<locale>/messages.json. When you add or change a string, update en/messages.json first, then keep the other locales in sync — every locale must define the same set of keys.

Checks

Run before opening a PR:

pnpm lint
pnpm typecheck
pnpm test
pnpm build

CI runs the same checks on every pull request.

Releases

Releases are automated. Bumping the version in src/manifest.json on main triggers the release workflow, which builds the Chrome and Opera archives and publishes them to a tagged GitHub release. Use pnpm bump to bump package.json and both manifests together.