From 6be0a9abc42646429f0ff98dd826e9db4443685c Mon Sep 17 00:00:00 2001
From: Alex Goodman <wagoodman@users.noreply.github.com>
Date: Fri, 12 Dec 2025 10:45:29 -0500
Subject: [PATCH] Improve PR template (#4472)

* improve pr template

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

* incorporate feedback

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>

---------

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
---
 .github/pull_request_template.md | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index faf52b8be..5f50a170c 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,11 +1,10 @@
-# Description
+## Description
 
-Please include a summary of the changes along with any relevant motivation and context,
-or link to an issue where this is explained.
+<!-- Please include a summary of the changes along with any relevant motivation and context -->
 
-<!-- If this completes an issue, please include: -->
+<!-- If CLI output changed, show an example (before/after if helpful) -->
 
-- Fixes
+<!-- If this changes application or API configuration, describe new/changed/removed options -->
 
 ## Type of change
 
@@ -18,8 +17,12 @@ or link to an issue where this is explained.
 - [ ] Chore (improve the developer experience, fix a test flake, etc, without changing the visible behavior of Syft)
 - [ ] Performance (make Syft run faster or use less memory, without changing visible behavior much)
 
-# Checklist:
+## Checklist
 
 - [ ] I have added unit tests that cover changed behavior
 - [ ] I have tested my code in common scenarios and confirmed there are no regressions
 - [ ] I have added comments to my code, particularly in hard-to-understand sections
+
+## Issue references
+
+<!-- If this fixes an issue, include "Fixes #<issue-number>" or otherwise list the issue references -->