From e6c223c8763a43db2d01a097dec3b4870a142c8d Mon Sep 17 00:00:00 2001 From: MAUstaoglu Date: Mon, 20 Jul 2026 16:58:45 +0200 Subject: [PATCH] chore: add pull request template MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds a PR template covering the two things most easily missed in this monorepo: per-package version bumps and CHANGELOG entries. Every package here is published to pub.dev independently, so a user-visible fix that doesn't bump pubspec.yaml never reaches anyone — which is exactly what happened in #4. The template also asks whether a change was verified on real hardware rather than only the simulator, since the simulator's sandbox is more permissive and masks device-only failures, and prompts contributors to flag behaviour changes and sibling packages affected by the same tvOS constraint. --- .github/pull_request_template.md | 45 ++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..05df28c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,45 @@ +## What does this PR do? + + + +**Package(s) touched:** + +## How was it tested? + + + +- [ ] Ran the package's `example/` app +- [ ] Verified on tvOS **simulator** (version: ___) +- [ ] Verified on a **physical Apple TV** (model / tvOS version: ___) +- [ ] `dart analyze` is clean for the package + +## Versioning & changelog + + + +- [ ] Bumped `version:` in the package's `pubspec.yaml` (or: no user-visible change — explain below) +- [ ] Added a matching entry at the top of the package's `CHANGELOG.md`, under a heading identical to the new version +- [ ] The entry calls out any **behaviour change** — a changed default path, a changed return value, anything that silently alters what an existing app sees +- [ ] Version choice follows semver for `0.x`: bug fix → patch (`0.0.1` → `0.0.2`); new API or breaking change → minor (`0.0.x` → `0.1.0`) + +## Checklist + +- [ ] Only the intended package's files are touched (this is a monorepo — unrelated packages should not appear in the diff) +- [ ] No secrets, absolute local paths, or `TODO`/debug leftovers in the diff +- [ ] If the change reflects a tvOS platform constraint (sandbox, focus engine, missing framework), the package `README.md` "Limitations / differs from iOS" section is updated to match +- [ ] If the same constraint affects sibling packages, they're noted below rather than fixed here + +## Notes for reviewers + + + +--- + +Maintainers: publishing to pub.dev is irreversible — a version number can never be reused. Run `dart pub publish --dry-run` and check the package's current `latest` on pub.dev before publishing.