Thanks for helping! This project is an unofficial, community-built desktop client for the Hugging Face Hub, licensed under Apache-2.0.
- English for code, identifiers, comments, commit messages, and repository docs.
- No hardcoded user-facing strings. Every string a user can see goes through i18n
(
react-i18nextin the renderer, thet()helper in the main process). CI enforces this witheslint-plugin-i18next. - No Hugging Face branding. Never add the 🤗 emoji, HF logos, or anything implying official status.
- Privacy-first. Optional pseudonymous usage telemetry is on by default in packaged releases
and must remain immediately opt-out from Settings. Its event allow-list is
telemetry_enabled,app_launched,star_prompt_shown,star_prompt_opened,star_prompt_snoozed,star_prompt_disabled, andstar_prompt_exhausted; the last event is restricted to prompt 2 withaction=exhausted. Keep properties limited to a random installation ID that persists only while telemetry remains enabled, schema/app version, platform, architecture, locale, and fixed prompt fields. Never include accounts, tokens, repository data, local paths, or file names, and preserve the immediate opt-out path. PostHog may see the source IP during transport: the project must disable IP capture in PostHog, and$geoip_disablemust remain set while being documented accurately as disabling only geographic enrichment. New events or properties must update tests and the documented telemetry contract. Tokens are only ever stored encrypted viasafeStorage. - Security baseline. Renderer stays sandboxed (
contextIsolation, nonodeIntegration); all IPC goes through the typed contract inpackages/sharedand validates input in the handler.
corepack enable
pnpm install
pnpm dev- Fork / branch from
main. - Make your change. Keep the app runnable —
pnpm devmust work at every commit. pnpm typecheck && pnpm lint && pnpm testmust pass.- If you touched UI strings, run
pnpm i18n:extractand fill in bothenandzh-CNlocales (machine-translated zh-CN is fine; mark it with// TODO(i18n): review). - Open a PR with a clear description.
- Copy
apps/desktop/src/renderer/src/i18n/locales/entolocales/<your-lang>/. - Translate each namespace JSON file.
- Add the locale to
SUPPORTED_LOCALESinpackages/shared/src/index.ts. - Add a main-process locale file under
apps/desktop/src/main/i18n/locales/. - Add the language name to the settings language picker (it reads
SUPPORTED_LOCALES).
See the Architecture section in README.md. Rule of thumb: network/disk/OS work goes
in apps/desktop/src/main (or packages/hub-api if it's pure API logic); anything visual goes in
apps/desktop/src/renderer; anything both sides need goes in packages/shared.