mirror of
https://github.com/ilyhalight/voice-over-translation.git
synced 2026-10-13 13:10:02 +00:00
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
[localize-link]: https://github.com/ilyhalight/localize/tree/master/packages/localize-tui
|
|
[votjs-link]: https://github.com/FOSWLY/vot.js
|
|
|
|
# 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](./src/types/localization.ts).
|
|
|
|
It's **RECOMMENDED** to automatically generate all the necessary phrases and types using the [localize][localize-link] script.
|
|
|
|
In this project, it's available using:
|
|
|
|
```bash
|
|
bun localize
|
|
```
|
|
|
|
or
|
|
|
|
```bash
|
|
npm localize
|
|
```
|
|
|
|
You can change the translation service in the [l10n.config.json](./l10n.config.json), but you **SHOULD NOT** commit it.
|
|
|
|
If you are editing the translation manually, then you **MUST** update the hash using [localize][localize-link] script.
|
|
|
|
|
|
|
|
## 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][votjs-link] and then add domain to match list in [headers.json](./src/headers.json).
|
|
|
|
Also, **DON'T forget** to add new paths to the [wiki data](./scripts/wiki-gen/data.js). This doesn't affect the functionality of the extension, but it is better to keep the wiki up to date.
|