Skip to content

Add pull request template#32

Merged
lukidoescode merged 1 commit into
mainfrom
lwagner/pr-template
May 21, 2026
Merged

Add pull request template#32
lukidoescode merged 1 commit into
mainfrom
lwagner/pr-template

Conversation

@lukidoescode

Copy link
Copy Markdown
Owner

Description

Adds .github/pull_request_template.md so GitHub pre-fills new PR descriptions with a structured template tailored to a Kubernetes operator project. Replaces ad-hoc PR shapes (and the generic ## Summary / ## Test plan default) with explicit prompts for the dimensions that matter here.

Template sections: linked issues (top bullets, matching the existing merged-PR convention), Description, Decisions Made, CRD / API Compatibility, Risks and Mitigations, Rollback Strategy, Verification. Helper prompts live in HTML comments so the rendered PR stays clean. No checkbox theater, no duplication of changeset-owned release notes.

Decisions Made

CRD / API Compatibility

N/A — no code, CRD, RBAC, or webhook changes.

Risks and Mitigations

  • Risk: template is too long and contributors ignore it. Mitigation: every section earns its place; HTML comments mean the rendered output is short.

Rollback Strategy

Delete .github/pull_request_template.md. No state, no migration.

Verification

  • Opened the file locally to confirm it renders correctly.
  • After merge: open a draft PR on any branch and confirm GitHub pre-fills the description with the template body.
  • No changeset required per CLAUDE.md (CI/docs-only change does not affect crate behavior).

@lukidoescode lukidoescode merged commit 1aa9f46 into main May 21, 2026
9 checks passed
@lukidoescode lukidoescode deleted the lwagner/pr-template branch May 21, 2026 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant