From 5d7ea5317444c9d7dfc9320bc5f0b4904842dc78 Mon Sep 17 00:00:00 2001 From: Mykhailo Chalyi Date: Wed, 8 Jul 2026 19:23:49 +0000 Subject: [PATCH] chore: standardize PR descriptions on functional change + before/after --- .github/pull_request_template.md | 12 ++++++++---- AGENTS.md | 16 ++++++++++++---- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4543575..8036f3c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,11 +1,15 @@ -## What -Clear description of the change. +## What changed +Describe the change functionally — what behavior changes and its impact on users +or callers. Lead with outcomes; don't walk through code locations, the diff shows +where and how. Keep any code-level notes short and specific. ## Why Problem or motivation. -## How -High-level approach. +## Before / After +Show the effect with evidence. Include before and after whenever behavior changes — +CLI/API output, logs, metrics, or screenshots for UI (attach working screenshots +when possible). For changes with no observable behavior (pure refactor, docs), say so. ## Risk - Low / Medium / High diff --git a/AGENTS.md b/AGENTS.md index 0ff5f53..2e68c95 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -199,17 +199,25 @@ npx commitlint --from HEAD~1 --to HEAD PR titles should follow Conventional Commits format. Use the PR template (`.github/pull_request_template.md`) for descriptions. +Center the description on functional change and impact, not a code-location +walkthrough (the diff shows that). Add a Before / After with proof — CLI/API +output, logs, metrics, or screenshots for UI — whenever behavior changes. + **PR Body Template:** ```markdown -## What -Clear description of the change. +## What changed +Describe the change functionally — what behavior changes and its impact. Lead with +outcomes; don't walk through code locations, the diff shows where and how. Keep any +code-level notes short and specific. ## Why Problem or motivation. -## How -High-level approach. +## Before / After +Show the effect with evidence. Include before and after whenever behavior changes — +CLI/API output, logs, metrics, or screenshots for UI (attach working screenshots +when possible). For changes with no observable behavior (pure refactor, docs), say so. ## Risk - Low / Medium / High