From 38d2c4a4ed263e10e868a1f86efc89fab6a36a30 Mon Sep 17 00:00:00 2001
From: Yuxuan Shui <yshuiv7@gmail.com>
Date: Fri, 14 Feb 2025 14:46:18 +0000
Subject: [PATCH] github: update pull request template

Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
---
 .github/pull_request_template.md | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index bbda91e6..284315f4 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,7 +1,18 @@
-<!-- Please enable "Allow edits from maintainers" so we can make necessary changes to your PR -->
+## Summary
 
-# Changelog
+<!-- If your pull request includes many commits, please provide a summary,
+     otherwise delete this section. We prefer you put detailed descriptions
+     in the commit messages. -->
 
-<!-- If you want to add a changelog entry for this PR, write it here; otherwise delete this section -->
-* Category: (Bug fixes, new features, etc.)
-* Description: (Describe changes made)
+## Checklist
+
+- [ ] Enable "Allow edits from maintainers". (So we can make necessary changes).
+- [ ] Add changelog entries to commit messages when appropriate. These will be included in release announcements.
+  <details>
+  Format the changelog entries like this:
+
+  `Changelog: BugFix: Stop picom from summoning the Great Old Ones.`
+
+  The entry starts with `Changelog: `, followed by a category name (`BugFix: ` in this case), then a short description of the changes in the commit.
+  <summary>How to format changelog entries</summary>
+  </details>