Thank you for considering a contribution.
- Test on additional Garmin devices.
- Add screenshots from real devices or the simulator.
- Improve Hebrew rendering and typography.
- Fix Hebrew or English strings.
- Verify parasha and Hebrew date edge cases.
- Test zmanim with different locations.
- Improve documentation.
- Install the Garmin Connect IQ SDK.
- Install Visual Studio Code and the Garmin Monkey C extension, or use Garmin CLI tools.
- Clone the repository.
- Open the project folder in VS Code.
- Build for a supported simulator device such as
fenix7.
Before opening a pull request:
- Run a clean build.
- Delete local
bin/,gen/,.logs/, and other generated artifacts before committing. - Do not commit Garmin developer keys.
- Do not commit private
.envfiles. - Add or update screenshots when changing the UI.
- Update
CHANGELOG.mdfor user-visible changes. - Confirm that all Hebrew strings render correctly on at least one MIP and one AMOLED simulator when possible.
- Keep Hebrew user-facing strings in resource files where possible.
- Avoid drawing Hebrew with Garmin system fonts unless confirmed on the target device.
- Prefer device-specific layout helpers over hard-coded positions.
- Keep touch-watch behavior phone-settings-first.
- Avoid converting the project to a watch face unless the product direction changes.
When reporting a bug, include:
- Garmin model or simulator target
- Connect IQ SDK version
- App version or commit hash
- Screenshot or short video if the issue is visual
- Expected behavior
- Actual behavior
- Steps to reproduce