Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Client impact

Describe how this change affects clients (e.g. behavior changes, upgrade steps, deprecations). If there is no client impact, state "None."

## Verification Plan

Describe how this change was tested or how a reviewer can verify it (e.g. steps to reproduce, automated tests added, manual QA steps).
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,36 @@ Rails or Ruby upgrade.
a comment explaining the blocker and a link to the tracking issue.
3. Never ignore a CVE silently — always add a justification comment.

#### Pull Request Body Requirements

Every pull request must include the following two sections in its body:

**Client impact** — Describe how this change affects end users, store operators, or
system integrators. If there is no user-visible effect, write "None" with a brief
explanation (e.g. "None (docs only)." or "None (internal refactor).").

**Verification Plan** — Describe the steps a reviewer can follow to confirm the
change works as intended. For automated changes this may reference the test suite;
for UI changes it should include manual steps.

Minimal example:

```markdown
## Client impact

Brief description of how clients / end users are affected, or "None" if not applicable.

## Verification Plan

1. Run `bin/rails test test/path/to/relevant_test.rb`
2. Visit /some-path and confirm the expected behaviour.
```

PRs that are missing either section may be closed without review until the body is
updated.

---

Thanks!

The Workarea Core Team
31 changes: 31 additions & 0 deletions script/gh_auth_check
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#!/usr/bin/env bash
# script/gh_auth_check
# Verifies that the GitHub CLI (gh) is installed and authenticated.
# Exits non-zero with actionable guidance if either check fails.

set -euo pipefail

# ── 1. Check gh is installed ──────────────────────────────────────────────────
if ! command -v gh &>/dev/null; then
echo "ERROR: gh CLI is not installed." >&2
echo "" >&2
echo "Install it with one of the following:" >&2
echo " macOS: brew install gh" >&2
echo " Linux: https://github.com/cli/cli/blob/trunk/docs/install_linux.md" >&2
echo " Windows: https://github.com/cli/cli#windows" >&2
exit 1
fi

# ── 2. Check gh is authenticated ─────────────────────────────────────────────
if ! gh auth status &>/dev/null; then
echo "ERROR: gh CLI is not authenticated." >&2
echo "" >&2
echo "Run the following to log in:" >&2
echo " gh auth login" >&2
echo "" >&2
echo "Then re-run this check:" >&2
echo " ./script/gh_auth_check" >&2
exit 1
fi

echo "gh CLI is installed and authenticated."
Loading