Skip to content

Contributing to EncodeX

Development

bash
npm run dev          # hot-reload dev mode
npm run electron:dev # full dev environment with Electron window
npm run build        # full build
npm start            # run built app

Project Conventions

  • TypeScript — strict mode, no any where possible.
  • React — functional components with hooks.
  • State — Zustand stores for global state.
  • IPC — all channels defined in src/shared/ipc-channels.ts.
  • Constants — hardcoded values in src/shared/ constants files.
  • i18n — all user-facing strings in src/renderer/i18n/locales/.

Pull Request Process

  1. Ensure the build passes: npm run build
  2. Update locale files if adding/modifying UI strings.
  3. Keep PRs focused on a single concern.

Code of Conduct

This project follows the Contributor Covenant.

Released under the MIT License.