|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Thanks for helping improve simplenotes. The goal of this project is a simple, local-first, open-source notes app with a strong mobile ink foundation. |
| 4 | + |
| 5 | +Small, focused contributions are welcome: bug reports, reproducible crashes, device-specific PDF import/export issues, documentation fixes, UI polish, and careful fixes to local storage or native integration all help. |
| 6 | + |
| 7 | +## Development Setup |
| 8 | + |
| 9 | +```sh |
| 10 | +npm ci --legacy-peer-deps |
| 11 | +npm run typecheck |
| 12 | +``` |
| 13 | + |
| 14 | +Run the app with an Expo dev client: |
| 15 | + |
| 16 | +```sh |
| 17 | +npx expo run:ios |
| 18 | +npx expo run:android |
| 19 | +``` |
| 20 | + |
| 21 | +Expo Go is not supported because the app depends on native code from `@mathnotes/mobile-ink`. |
| 22 | + |
| 23 | +## Pull Request Expectations |
| 24 | + |
| 25 | +- Keep changes focused and easy to review. |
| 26 | +- Run `npm run typecheck` before opening a PR. |
| 27 | +- Rebuild and manually test on a real device when touching native code, PDF import/export, file handling, or Mobile Ink integration. |
| 28 | +- Do not include private notes, imported PDFs, screenshots with personal information, credentials, signing files, generated build outputs, or local caches. |
| 29 | +- Preserve the local-first privacy model. Do not add analytics, tracking, account systems, sync services, or network calls without a clear public discussion first. |
| 30 | + |
| 31 | +## App And Engine Boundaries |
| 32 | + |
| 33 | +Use this repo for the simplenotes app: library UX, note storage, PDF import/export behavior, app chrome, and platform submission work. |
| 34 | + |
| 35 | +Use [`mathnotes-app/mobile-ink`](https://github.com/mathnotes-app/mobile-ink) for reusable ink-engine bugs, canvas primitives, native rendering, selection behavior, stroke serialization, and engine-level PDF/page handling. |
| 36 | + |
| 37 | +If a bug crosses both repos, open the app issue here and link the Mobile Ink issue or PR. |
0 commit comments