voice-over-translation/CONTRIBUTING.md
Toil 576793ffb5
Some checks are pending
Build / node (22.x) (push) Waiting to run
Build / extension (22.x) (push) Waiting to run
Build / bun (push) Waiting to run
Release / Build Release (push) Waiting to run
Release / create_release (push) Blocked by required conditions
docs: updated CONTRIBUTING.md guide
2026-07-30 00:30:46 +03:00

1.4 KiB

Contributing guide

If possible, all new code SHOULD BE written with TypeScript. AVOID comits of files from dist folder.

localization

All phrases MUST BE added to the Phrase and Phrases types in localization.ts.

It's RECOMMENDED to automatically generate all the necessary phrases and types using the localize script.

In this project, it's available using:

bun localize

or

npm localize

You can change the translation service in the l10n.config.json, but you SHOULD NOT commit it.

If you are editing the translation manually, then you MUST update the hash using localize script.

example

vot.js

DON'T forget to pass { fetchFn: GM_fetch } option to getVideoID and getVideoData

Adding support for new sites

To add support for a new sites, you need make neaccessary changes in vot.js and then add domain to match list in headers.json.

Also, DON'T forget to add new paths to the wiki data. This doesn't affect the functionality of the extension, but it is better to keep the wiki up to date.