Skip to content

Add pull request template with testing checklist #139

@smoparth

Description

@smoparth

Problem

The repo has no pull request template. Contributors (human and AI agents) can submit PRs without confirming they followed the required workflow — edit templates not version-specific files, build the image, run tests with correct env vars. This leads to avoidable CI failures and review delays.

What needs to happen

Add .github/PULL_REQUEST_TEMPLATE.md with sections and a testing checklist specific to this repo's workflow.

Template should include

Sections:

  • What — brief description of the change
  • Why — link to issue or motivation

Testing checklist (checkboxes):

  • Linting passes: tox -e lint (covers ruff + Containerfile hadolint)
  • Type checking passes: tox -e type
  • Image builds: ./scripts/build.sh <type>-<version>
  • Image tests pass: pytest tests/ -v with appropriate *_IMAGE env vars

Repo-specific reminders (checkboxes):

  • Edited the template (Containerfile.*.template), not version-specific Containerfiles directly
  • Build args are in app.conf, not hardcoded in Containerfiles
  • No :latest tags in production builds
  • Container does not run as root (UID 0) in final image

Notes

  • The checklist items map directly to the anti-patterns documented in AGENTS.md under "Things to Avoid".
  • Keep it concise — a wall of text gets ignored. Checkbox items only, no prose paragraphs.

Definition of Done

  • .github/PULL_REQUEST_TEMPLATE.md exists
  • Includes What/Why sections
  • Includes testing checklist with the specific tox/build/pytest commands for this repo
  • Includes repo-specific reminders (template editing, no hardcoded versions, no root)
  • Template renders correctly when opening a new PR on GitHub (manual verification)

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions