Merge pull request #7 from HackYourFuture/docs/pr-packaging-template

docs+ci: strengthen PR template (expected results) + enforce in CI

Author: lassebenni

.github/PULL_REQUEST_TEMPLATE.md

@@ -21,6 +21,19 @@ uv run streamlit run app.py
 
 Prerequisite: your own `fct_trips` mart populated in your `dev_<name>` schema (from Week 10).
 
+> Data dependency: these run steps need **your own** Week 10 mart. A reviewer who does not have that data cannot rebuild your numbers, so the committed **screenshots / PDF export are the canonical evidence** of a working submission.
+
+## What reviewers should see (expected results)
+Fill in the numbers your dashboard and app actually show, so a reviewer can tell at a glance whether the result looks correct:
+- Total trips (`fct_trips` row count): <e.g. ~57k>
+- Busiest hour of day: <e.g. 18:00>
+- Top payment type by share: <e.g. credit card, ~70%>
+- Data freshness (latest trip date shown): <e.g. 2023-01-31>
+
+## Known limitations / out of scope
+- <e.g. auto-refresh not implemented; dashboard covers January 2023 only; one Metabase filter still hardcoded>
+- Write "none" if everything in the assignment is done and working.
+
 ## Extra completed
 - [ ] Metabase date filter on >=2 Questions
 - [ ] Streamlit auto-refresh

.github/workflows/pr-body-check.yml

@@ -0,0 +1,52 @@
+name: PR body check
+
+# Fails the check when a pull request description is missing the sections from
+# .github/PULL_REQUEST_TEMPLATE.md. GitHub only auto-fills that template in the
+# web "compose" form and in `gh pr create` with no --body; a PR opened through
+# the REST API or `gh pr create --body "..."` (the path most AI tools take)
+# silently skips it. This check is the only thing that actually enforces it.
+#
+# Recovery is automatic: editing the PR description fires the `edited` event and
+# re-runs this check with the new body. No new commit or manual re-run needed.
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check required sections are present
+        env:
+          PR_BODY: ${{ github.event.pull_request.body }}
+        run: |
+          set -euo pipefail
+          required=(
+            "## What I built"
+            "## How to review"
+            "## How to run"
+            "## What reviewers should see"
+            "## Self-check"
+          )
+          missing=()
+          for section in "${required[@]}"; do
+            if ! printf '%s' "$PR_BODY" | grep -qiF "$section"; then
+              missing+=("$section")
+            fi
+          done
+          if [ ${#missing[@]} -ne 0 ]; then
+            echo "::error::Your PR description is missing required sections. Start from the template (.github/PULL_REQUEST_TEMPLATE.md) and keep these headings:"
+            for m in "${missing[@]}"; do echo "  - $m"; done
+            echo ""
+            echo "If you (or an AI tool) opened this PR without the template, click 'Edit' on the"
+            echo "PR description, paste the template, and fill it in. Editing the description"
+            echo "re-runs this check automatically. A complete PR is easy to review and"
+            echo "reproducible: that is part of the assignment."
+            exit 1
+          fi
+          echo "All required PR sections present."