From 40afe12ab1ed4db4740ead70b3d5baf1bc35ad7d Mon Sep 17 00:00:00 2001
From: roboclaw-bot <309084314+roboclaw-bot@users.noreply.github.com>
Date: Sat, 12 Sep 2026 19:40:57 +0000
Subject: [PATCH] docs: make PR descriptions plain-language first
Co-authored-by: hannesrudolph <49103247+hannesrudolph@users.noreply.github.com>
---
.github/pull_request_template.md | 36 ++++++++++++++++----------------
CONTRIBUTING.md | 5 +++--
2 files changed, 21 insertions(+), 20 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index b79ac3e6..08e9180f 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -13,10 +13,6 @@ For fixes, describe the user-visible symptom and trigger:
fix: launcher exits without a diagnostic when Node is missing
Avoid implementation details such as:
fix: add null check to payload resolver
--->
-
-
-Additional instructions
**MUST:** Keep **Allow edits from maintainers** enabled for this PR so
maintainers can help update the branch when needed.
@@ -24,37 +20,39 @@ maintainers can help update the branch when needed.
See [CONTRIBUTING.md](../CONTRIBUTING.md) for the validation commands this
repository expects and for the packaging, signing, and NativeAOT rules that
apply to launcher changes.
-
-
+-->
## What Problem This Solves
-## Why This Change Was Made
+## User Impact
-## User Impact
+## Why This Change Was Made
## Evidence
@@ -73,4 +71,6 @@ Include CI links, artifact links, redacted logs, or terminal output. State
which lanes you did not run and why. Reviewers will inspect the code, tests,
and CI; use this section to make validation easy to understand rather than to
restate the diff.
+Summarize what was checked and the result; note meaningful gaps. Link long output
+or put it in optional , keeping the useful evidence summary visible.
-->
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c6549aca..52b218bf 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -203,8 +203,9 @@ Use the pull request template. Title the PR
`improve`, `refactor`, `docs`, or `chore`. Describe the outcome rather than the
mechanism.
-Every PR body should explain the problem it solves, why the change was made,
-the user or contributor impact, and the evidence that it works. Name the exact
+Lead with the problem and user or contributor impact in short, plain-language
+sentences, followed by a brief explanation and useful evidence. Keep technical
+details optional, but important risks and required actions visible. Name the exact
head SHA your evidence came from and state which validation lanes you did not
run.