Skip to content

Contributing

Sandeep Vattapparambil edited this page Aug 19, 2026 · 1 revision

🀝 Contributing

πŸ§‘β€πŸ’» Development

npm run dev    # hot-reload dev mode
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.

πŸ”’ Security

If you discover a security vulnerability, please report it through the security advisory. Do not report security vulnerabilities through public GitHub issues.

We will acknowledge receipt within 48 hours and provide an estimated timeline for a fix.

πŸ“œ Code of Conduct

This project follows the Contributor Covenant Code of Conduct.

Clone this wiki locally