Skip to content

chore: replace PR template with Summary/Why/Test-plan format#122

Open
basebandit wants to merge 2 commits into
mainfrom
chore/pr-template
Open

chore: replace PR template with Summary/Why/Test-plan format#122
basebandit wants to merge 2 commits into
mainfrom
chore/pr-template

Conversation

@basebandit
Copy link
Copy Markdown
Owner

Summary

  • Replaces the prior Description / Type-of-change / 8-item hygiene checklist with a leaner Summary / Why / Test plan format.
  • Test plan now lists concrete commands (go build, go vet, go test -race) so reviewers know exactly what was verified.

Why

The old template's generic checklist ("My code follows the style guidelines", "I have performed a self-review") was performative — authors tick boxes without reading, and reviewers gain nothing. The free-form Description had no dedicated Why section, so motivation got buried and PR archaeology suffered six months later. The new format forces the author to state motivation explicitly and verify with real commands.

Test plan

  • Template renders correctly on next PR opened against this branch's merge.

@sonarqubecloud
Copy link
Copy Markdown

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