Skip to content

docs: add pull request template with cross-repo checklist - #1034

Merged
mbevc1 merged 3 commits into
mainfrom
20260726_pr_template
Jul 28, 2026
Merged

docs: add pull request template with cross-repo checklist#1034
mbevc1 merged 3 commits into
mainfrom
20260726_pr_template

Conversation

@mbevc1

@mbevc1 mbevc1 commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Adds pull_request_template.md so every PR gets a description prompt and a checklist reminding authors to check related surfaces: Helm chart (separate PR), Terraform provider, and docs.

@mbevc1 mbevc1 added the documentation Improvements or additions to documentation label Jul 26, 2026
@claude

claude Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mbevc1's task in 27s —— View job


PR Review: Add pull request template

  • Read the changed file
  • Verify prior review feedback was addressed
  • Review content & conventions

This is a docs-only change adding a single .github/pull_request_template.md. No Go code changed, so go build/go vet/go mod tidy are not applicable here.

Prior feedback is resolved ✅ — the earlier grammar issue (in a needs a separate PR) and the thise changes typo are both gone. Line 7 now reads cleanly:

- [ ] **Helm chart** (charts/k8s-reporter/) updated, if needed. Note: these changes live in a **separate PR**

Observations (all minor / optional):

  1. Trailing punctuation is inconsistent across the checklist. Line 7 ends with a full sentence + period, while lines 8 and 9 have no terminating period. Consider making them uniform (e.g. add a period to each, or drop the one on line 7) for a tidy look.

  2. .github/pull_request_template.md:9 — "Docs are autogenerated from CLI help" is a helpful reminder. You might optionally point contributors at the command that regenerates them (if one exists) so the reminder is actionable, but this is not blocking.

  3. The cross-repo checklist (Helm, Terraform providers, docs) is a nice touch — the explicit repo links on line 8 are genuinely useful for reviewers who won't remember every downstream surface. 👍

Verdict: Content is clear, the checklist is well-scoped, and all previously raised comments have been addressed. Already approved by @AlexKantor87 — looks good to merge. Nice, low-risk quality-of-life improvement to the repo. 🎉
20260726_pr_template

Comment thread .github/pull_request_template.md Outdated
@mbevc1
mbevc1 force-pushed the 20260726_pr_template branch from bc2d876 to b673537 Compare July 26, 2026 21:21
@mbevc1
mbevc1 enabled auto-merge (squash) July 26, 2026 21:24
Comment thread .github/pull_request_template.md Outdated
mbevc1 and others added 3 commits July 28, 2026 12:18
Adds `pull_request_template.md` so every PR gets a description
prompt and a checklist reminding authors to check related surfaces:
Helm chart (separate PR), Terraform provider, and docs.
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
@mbevc1
mbevc1 force-pushed the 20260726_pr_template branch from 2ca3001 to 7e3c544 Compare July 28, 2026 11:18
@mbevc1
mbevc1 merged commit c8d0724 into main Jul 28, 2026
16 checks passed
@mbevc1
mbevc1 deleted the 20260726_pr_template branch July 28, 2026 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants