You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- React components are PascalCase (`CharacterModal.jsx`), utilities/modules are kebab or camel case (`asr-cache-env.js`).
22
+
- Keep Electron main/preload logic in `src/` and avoid mixing UI concerns into main process modules.
23
+
24
+
## Testing Guidelines
25
+
- Automated tests are mostly script-driven: `pnpm run test:asr`, `pnpm run test:settings-logs`, `pnpm run test:audio`.
26
+
- Additional utilities live in `scripts/test-*.{js,py}`; run them directly when validating audio/ASR flows.
27
+
- Name new tests with clear `test-` prefixes and document any required hardware or model downloads.
28
+
29
+
## Commit & Pull Request Guidelines
30
+
- Commit messages generally follow Conventional Commits (`feat(scope):`, `fix(scope):`, `refactor(scope):`). Use a short, scoped summary.
31
+
- Git history shows these common types/scopes: `feat`, `fix`, `refactor`, `chore`, `security` with scopes like `main`, `ci`, `python-env`, `asr`, `ui`, `docs`, `review`, `prompt`, `tests`.
32
+
- Messages may be bilingual (English/中文); keep them concise and consistent with existing history.
33
+
- PRs should describe user-facing behavior changes, note platform impact (macOS/Windows), and include screenshots/GIFs for UI updates.
34
+
- If the change touches ASR or model caches, mention any new env vars or migration steps.
35
+
36
+
## Configuration & Security Notes
37
+
- Local ASR caches can be redirected via `ASR_CACHE_BASE`; keep sensitive paths out of logs.
38
+
- Avoid widening IPC surface area without validation (see `src/core/modules/`).
0 commit comments