Skip to content

Open-source gym & body-weight tracker, now in the App Store (iPhone + Apple Watch) and as an Android APK. Plan routines, log workouts, see which muscles are trained, import from Strong/Hevy/FitNotes. Self-host it or use it on the phone alone.

Issue and PR templates: the phone apps, the version, a GitHub PR template

Duarte Santos2176a812f37f
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index dfc821eab..ebc14bf19 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -32,19 +32,34 @@ body:
- type: dropdown
id: setup
attributes:
- label: How are you running openGym?
+ label: Where does it happen?
options:
- - Self-hosted (docker compose)
+ - iPhone or iPad app (App Store or TestFlight)
+ - Apple Watch app
+ - Android app (APK)
+ - Android app (Google Play)
+ - Browser, on my own server (docker compose, Helm, Nix...)
+ - Browser, on someone else's instance
+ - The demo on opengym.ch
- Frontend dev server (npm run dev)
- Other / not sure
validations:
required: true
+ - type: input
+ id: version
+ attributes:
+ label: openGym version
+ description: Settings, About & updates, Version. On a server, the image tag works too.
+ placeholder: e.g. 1.4.2
+ validations:
+ required: false
+
- type: input
id: environment
attributes:
- label: Browser & OS
- placeholder: e.g. Safari 17 on iOS 18, Chrome 126 on Android
+ label: Device, OS and browser
+ placeholder: e.g. iPhone 15 on iOS 26, Pixel 8 on Android 16, Firefox 140 on Windows
validations:
required: true
@@ -53,7 +68,7 @@ body:
attributes:
label: Is this about login / passkeys?
description: >
- Most login issues are an `RP_ID`/`ORIGIN` mismatch — check your `.env` against the
+ Most login issues are an `RP_ID`/`ORIGIN` mismatch. Check your `.env` against the
domain you're accessing openGym from before reporting. See the
[self-hosting guide](../../docs/SELF_HOSTING.md).
options:
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 9d564f0d8..9dd8287e4 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -2,10 +2,10 @@ blank_issues_enabled: false
contact_links:
- name: Question or self-hosting help
url: https://github.com/DuarteSantos8/openGym/discussions/categories/q-a
- about: Login/passkey trouble, reverse proxies, Docker, "how do I…" — ask in Q&A, not in an issue.
+ about: Login/passkey trouble, reverse proxies, Docker, "how do I…"? Ask in Q&A, not in an issue.
- name: Idea or feature request to talk through
url: https://github.com/DuarteSantos8/openGym/discussions/categories/ideas
- about: Not sure it belongs in the app yet? Float it in Ideas first — issues are for agreed work.
+ about: Not sure it belongs in the app yet? Float it in Ideas first, issues are for agreed work.
- name: Show your setup
url: https://github.com/DuarteSantos8/openGym/discussions/categories/show-and-tell
about: Running openGym somewhere interesting, or built something on top of it? Show it off.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index 8813faacf..85597240d 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -23,7 +23,7 @@ body:
attributes:
label: Dependencies
description: >
- openGym is intentionally dependency-light — new packages (front or back) are a hard
+ openGym is intentionally dependency-light: new packages (front or back) are a hard
sell. See [CONTRIBUTING.md](../../CONTRIBUTING.md).
options:
- label: This doesn't require adding a new dependency
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..1647794e5
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,23 @@
+### What this changes
+
+### Why
+
+<!-- Link the issue if there is one: Closes #123 -->
+
+### How you checked it
+
+<!-- What you clicked through, on which device. Screenshots welcome for anything you can see. -->
+
+### Checklist
+
+- [ ] `npm test` passes in `frontend/` (and in `api/` or `mcp/` if you touched them)
+- [ ] New UI strings are in every locale pack (`cd frontend && node scripts/check-locales.mjs`)
+- [ ] Training logic (what you lift next, how a session is read back) has a unit test beside it
+- [ ] If you changed a rule that exists in both `frontend/src/lib` and `api/`, both sides changed
+ ([which ones](https://github.com/DuarteSantos8/openGym/blob/main/docs/ARCHITECTURE.md#code-that-exists-twice-on-purpose))
+- [ ] No new dependency, or the description says why it can't be avoided
+- [ ] Nothing added to `catalogue/media/`, and CHANGELOG.md left alone (release notes are written
+ at release time)
+
+<!-- First pull request? The CLA check asks you to sign once with a comment (see CLA.md).
+ Its workflows wait for a maintainer to start them, so "no checks yet" is normal. -->