From 9056fb58b78ff9eb3d65ecaa905ea6205af3aca3 Mon Sep 17 00:00:00 2001
From: Anton Nekipelov <226657+anton-107@users.noreply.github.com>
Date: Fri, 28 Feb 2025 15:33:32 +0100
Subject: [PATCH] Improve the PR template, add a "why" section (#2402)

## Changes
1. Add a Why section to the pull request template
2. Slightly improve language in the existing sections

## Why
Providing the right context for the reviewer in the PR description is
important as it usually cannot be inferred from the code itself. The new
section directly prompts the requester to provide such context

## Tests
Checked that the markdown is still rendered correctly in the local
viewer
---
 .github/PULL_REQUEST_TEMPLATE.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 5be087016..2f8597999 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,10 @@
 ## Changes
-<!-- Summary of your changes that are easy to understand -->
+<!-- Brief summary of your changes that is easy to understand -->
+
+## Why
+<!-- Why are these changes needed? Provide the context that the reviewer might be missing. 
+For example, were there any decisions behind the change that are not reflected in the code itself? -->
 
 ## Tests
-<!-- How is this tested? -->
+<!-- How have you tested the changes? -->