From ad022017b688bf418b8fcf260816ada447db55b7 Mon Sep 17 00:00:00 2001
From: Thomas Eizinger <thomas@eizinger.io>
Date: Fri, 10 Mar 2023 17:21:43 +1100
Subject: [PATCH] chore: update pull-request template

With the adoption of mergify, we now use the `## Description` section as the commit message. Update the PR template to guide users towards crafting a good commit message. Specifically, ask them to point to relevant issues and PRs at the end of the message instead of in a separate section.

Pull-Request: #3570.
---
 .github/pull_request_template.md | 23 +++++++++++++----------
 1 file changed, 13 insertions(+), 10 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 60d06fee8ed..f724d2fd7de 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,19 +1,22 @@
 ## Description
 
-<!-- Please write a summary of your changes and why you made them.-->
-<!-- This section will appear as the commit message after merging. Please craft it accordingly. -->
+<!--
+Please write a summary of your changes and why you made them.
+This section will appear as the commit message after merging.
+Please craft it accordingly.
+For a quick primer on good commit mesages, check out this blog post: https://cbea.ms/git-commit/
 
-## Notes
+Please include any relevant issues in here, for example:
 
-<!-- Any notes or remarks you'd like to make about the PR. -->
+Related https://github.com/libp2p/rust-libp2p/issues/ABCD.
+Fixes https://github.com/libp2p/rust-libp2p/issues/XYZ.
+-->
 
-## Links to any relevant issues
+## Notes & open questions
 
-<!-- Reference any related issues.-->
-
-## Open Questions
-
-<!-- Unresolved questions, if any. -->
+<!--
+Any notes, remarks or open questions you have to make about the PR which don't need to go into the final commit message.
+-->
 
 ## Change checklist